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

# Retire a messaging app

> Retire an app definition, uninstall all of its installations, revoke proactive targets, and detach provider and installation credentials.



## OpenAPI

````yaml /v2/storefront-api-v2.yaml patch /messaging-apps/{definitionId}
openapi: 3.0.0
info:
  title: Scope3 Storefront API
  version: 2.0.0
  description: >-
    REST API for partners to manage Seller Accounts, inventory sources, and
    billing.


    ## Authentication


    All endpoints require a Bearer token in the Authorization header:

    ```

    Authorization: Bearer your-api-key

    ```


    ## Base URL


    `https://api.interchange.io/api/v2/storefront`


    ## For AI Agents


    AI agents can use the MCP endpoint at `/mcp/v2/storefront` with three tools:

    - `initialize`: Start an MCP session

    - `api_call`: Make REST API calls

    - `ask_about_capability`: Learn about API features
servers:
  - url: https://api.interchange.io/api/v2/storefront
    description: Production server
security: []
tags:
  - name: Account
    description: Account management, service tokens, and preferences
  - name: Asks
    description: >-
      What you are waiting on Scope3 for — support, product, and supply asks in
      one list
  - name: Storefront
    description: Manage storefront and inventory sources
  - name: Storefront Agents
    description: List and manage registered sales, signals, and outcomes agents
  - name: Storefront Activity
    description: Audit log of configuration and inventory changes on the storefront
  - name: Storefront Billing
    description: Payout bank details and billing configuration for Seller Accounts
  - name: AI Usage
    description: Seller Account AI token usage visibility by model
  - name: MCP
    description: Model Context Protocol endpoints
paths:
  /messaging-apps/{definitionId}:
    servers:
      - url: https://api.interchange.io/api/v2
        description: Production server
    patch:
      tags:
        - Account
      summary: Retire a messaging app
      description: >-
        Retire an app definition, uninstall all of its installations, revoke
        proactive targets, and detach provider and installation credentials.
      operationId: retireMessagingApp
      parameters:
        - in: path
          name: definitionId
          schema:
            type: string
            format: uuid
            pattern: >-
              ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
          required: true
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                status:
                  type: string
                  enum:
                    - retired
              required:
                - status
              additionalProperties: false
      responses:
        '200':
          description: Retire a messaging app
          content:
            application/json:
              schema:
                type: object
                properties:
                  definition:
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                        pattern: >-
                          ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                      customerId:
                        type: integer
                        minimum: 0
                        exclusiveMinimum: true
                        maximum: 9007199254740991
                      agentKey:
                        type: string
                        minLength: 1
                        maxLength: 128
                      brand:
                        type: object
                        properties:
                          displayName:
                            type: string
                            minLength: 1
                            maxLength: 80
                          shortDescription:
                            type: string
                            minLength: 1
                            maxLength: 200
                          accentColor:
                            type: string
                            pattern: ^#[0-9a-f]{6}$
                          iconAssetId:
                            type: string
                            format: uuid
                            pattern: >-
                              ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                          supportUrl:
                            type: string
                            format: uri
                            pattern: ^https:\/\/.*
                          privacyPolicyUrl:
                            type: string
                            format: uri
                            pattern: ^https:\/\/.*
                          termsUrl:
                            type: string
                            format: uri
                            pattern: ^https:\/\/.*
                        required:
                          - displayName
                          - supportUrl
                          - privacyPolicyUrl
                        additionalProperties: false
                      providerRef:
                        oneOf:
                          - type: object
                            properties:
                              provider:
                                type: string
                                enum:
                                  - slack
                              applicationId:
                                type: string
                                minLength: 1
                                maxLength: 2048
                            required:
                              - provider
                              - applicationId
                            additionalProperties: false
                          - type: object
                            properties:
                              provider:
                                type: string
                                enum:
                                  - teams
                              applicationId:
                                type: string
                                minLength: 1
                                maxLength: 2048
                            required:
                              - provider
                              - applicationId
                            additionalProperties: false
                          - type: object
                            properties:
                              provider:
                                type: string
                                enum:
                                  - discord
                              applicationId:
                                type: string
                                minLength: 1
                                maxLength: 2048
                            required:
                              - provider
                              - applicationId
                            additionalProperties: false
                          - type: object
                            properties:
                              provider:
                                type: string
                                enum:
                                  - whatsapp
                              businessAccountId:
                                type: string
                                minLength: 1
                                maxLength: 2048
                              phoneNumberId:
                                type: string
                                minLength: 1
                                maxLength: 2048
                            required:
                              - provider
                              - businessAccountId
                              - phoneNumberId
                            additionalProperties: false
                        type: object
                      status:
                        type: string
                        enum:
                          - draft
                          - active
                          - retired
                    required:
                      - id
                      - customerId
                      - agentKey
                      - brand
                      - providerRef
                      - status
                    additionalProperties: false
                required:
                  - definition
                additionalProperties: false
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Active organization admin required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Active app definition not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    ErrorResponse:
      type: object
      properties:
        data:
          type: string
          nullable: true
          enum:
            - null
        error:
          $ref: '#/components/schemas/ApiError'
      required:
        - data
        - error
      additionalProperties: false
      description: Standard error response
    ApiError:
      type: object
      properties:
        code:
          type: string
          description: Machine-readable error code
        message:
          type: string
          description: Human-readable error message
        field:
          description: Field path associated with the error
          type: string
        details:
          description: Additional error context
          type: object
          additionalProperties: {}
      required:
        - code
        - message
      additionalProperties: false
      description: Structured error object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key or access token

````