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

# Pin conversation

> Pins a conversation for the caller. Up to 10 conversations can be pinned. Pinning a conversation that is already pinned returns `204` and changes nothing. A missing or blank `allo_number` returns `400` `INVALID_REQUEST_BODY`.

> [!NOTE]
>
> **Required scope:** `CONVERSATIONS_WRITE`

## Behavior

Pins the conversation with `contact_number` on the Allo line `allo_number`, for the caller only. Returns `204` with no body, also when the conversation is already pinned.

Each user can pin up to 10 conversations. Filter pinned conversations with `pinned=true` on [List conversations](https://help.withallo.com/en/v2/api-reference/conversations/list-conversations.md).

## Errors

| Status | Code | When |
| - | - | - |
| `400` | `INVALID_REQUEST_BODY` | `allo_number` is missing or blank |
| `403` | `ALLO_NUMBER_FORBIDDEN` | The caller cannot access this line |
| `409` | `PIN_LIMIT_REACHED` | The caller already has 10 pinned conversations. Unpin one first |


## OpenAPI

````yaml PUT /v2/api/conversations/{contact_number}/pin
openapi: 3.0.3
info:
  title: Allo API
  description: >-
    Allo API provides programmatic access to your Allo account, allowing you to
    manage webhooks, retrieve calls and contacts, and send SMS messages.


    All requests to `/v1/api/**` endpoints automatically go through quota
    checking and scope validation.
  version: 1.0.0
  contact:
    name: Allo Support
servers:
  - url: https://api.withallo.com
    description: Production server
security: []
tags:
  - name: Summary Templates
    description: >-
      Manage call summary templates that control how AI-generated call summaries
      are structured for your team.
  - name: Webhooks
    description: >-
      Manage webhook endpoints to receive real-time notifications about events
      in your Allo account. Each endpoint subscribes to one or more event topics
      and is verified with a signing secret.
  - name: Calls
    description: >-
      Retrieve and search call records with filtering and pagination. Filter
      calls by your Allo phone number.
  - name: Contacts
    description: >-
      Search and retrieve contact information with sorting and pagination.
      Includes engagement level tracking.
  - name: SMS
    description: Send SMS messages to phone numbers using your Allo numbers.
  - name: Phone Numbers
    description: Retrieve information about your Allo phone numbers.
  - name: Analytics
    description: Pre-computed call metrics, team performance, and outbound dial funnel
  - name: CRM
    description: Manage people, companies, and deals in your CRM.
  - name: Notes
    description: >-
      Internal team notes on conversations and CRM people, with @mention
      support. Notes are never visible to the contact.
  - name: Threads
    description: >-
      Team discussion threads attached to a conversation item (call, SMS, or
      conversation note). One thread per item.
  - name: AI Receptionist
    description: >-
      Read and write the AI receptionist configuration of a phone line: business
      details, voice, prompt, capabilities, business hours, transfer rules,
      scheduling calendars and knowledge sources.
  - name: Inboxes
    description: >-
      Personal inboxes: saved views of one or more lines, optionally narrowed to
      phone-menu options, with their own filters and notification setting.
paths:
  /v2/api/conversations/{contact_number}/pin:
    put:
      tags:
        - Conversations
      summary: Pin conversation
      description: >-
        Pins a conversation for the caller. Up to 10 conversations can be
        pinned. Pinning a conversation that is already pinned returns `204` and
        changes nothing. A missing or blank `allo_number` returns `400`
        `INVALID_REQUEST_BODY`.
      operationId: pinConversation
      parameters:
        - name: contact_number
          in: path
          required: true
          description: >-
            The external phone number in E.164 format. URL-encode the `+` as
            `%2B`.
          schema:
            type: string
            example: '+14155551234'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                allo_number:
                  type: string
                  description: Allo line the conversation is on (E.164).
                  example: '+14155550100'
              required:
                - allo_number
            example:
              allo_number: '+14155550100'
      responses:
        '204':
          description: Conversation pinned
        '400':
          $ref: '#/components/responses/ApiValidationError'
        '401':
          $ref: '#/components/responses/ApiUnauthorized'
        '403':
          $ref: '#/components/responses/ApiForbidden'
        '409':
          $ref: '#/components/responses/ApiConflict'
        '429':
          $ref: '#/components/responses/ApiRateLimited'
      security:
        - ApiKeyAuth: []
components:
  responses:
    ApiValidationError:
      description: Invalid request parameters
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    ApiUnauthorized:
      description: Invalid or missing API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    ApiForbidden:
      description: API key lacks the required scope or access to the resource
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    ApiConflict:
      description: Conflict with existing resource
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    ApiRateLimited:
      description: Rate limit exceeded
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  schemas:
    ApiError:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
            code:
              type: string
            message:
              type: string
            retryable:
              type: boolean
            request_id:
              type: string
            retry_after_seconds:
              type: integer
              nullable: true
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization

````

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