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

# Connect a CRM via API key (e.g. LeadSquared)

**Required scope:** `crm.edit`


## OpenAPI

````yaml /api-reference/openapi.json post /crm/{slug}/connect
openapi: 3.0.3
info:
  title: Pineyard API
  version: 1.0.0
  description: >-
    Programmatic access to agents, campaigns, calls, phone numbers, WhatsApp and
    results in your Pineyard workspace.
servers:
  - url: https://api.pineyard.ai
    description: Production
security:
  - bearerAuth: []
paths:
  /crm/{slug}/connect:
    post:
      summary: Connect a CRM via API key (e.g. LeadSquared)
      parameters:
        - schema:
            type: string
          required: true
          name: slug
          in: path
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 120
                credentials:
                  type: object
                  additionalProperties:
                    type: string
              required:
                - name
                - credentials
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  connection:
                    type: object
                    properties:
                      id:
                        type: string
                      slug:
                        type: string
                      name:
                        type: string
                      status:
                        type: string
                        enum:
                          - ACTIVE
                          - REVOKED
                          - ERROR
                      providerEmail:
                        type: string
                        nullable: true
                      connectedAt:
                        type: string
                      display:
                        type: object
                        nullable: true
                        additionalProperties:
                          nullable: true
                      hasWebhookSecret:
                        type: boolean
                      webhookUrl:
                        type: string
                      deferredEventCount:
                        type: integer
                        minimum: 0
                      missingScopes:
                        type: array
                        items:
                          type: string
                      webhookTopics:
                        type: object
                        nullable: true
                        properties:
                          subscribed:
                            type: array
                            items:
                              type: string
                          failed:
                            type: array
                            items:
                              type: object
                              properties:
                                topic:
                                  type: string
                                reason:
                                  type: string
                              required:
                                - topic
                                - reason
                          checkedAt:
                            type: string
                        required:
                          - subscribed
                          - failed
                          - checkedAt
                    required:
                      - id
                      - slug
                      - name
                      - status
                      - providerEmail
                      - connectedAt
                      - display
                      - hasWebhookSecret
                      - webhookUrl
                      - deferredEventCount
                      - missingScopes
                      - webhookTopics
                required:
                  - connection
        '400':
          description: >-
            - `internal_error`: An unexpected error. A `400` with this code
            usually means the body is not valid JSON; a `413` means the body is
            larger than 1 MB.

            - `invalid_body`: The request body (or query) failed validation.
            Details are in `issues` (or `detail`). `422` on `POST
            /v1/campaigns/{campaignId}/leads`.

            - `invalid_credentials`: The credentials for the connected service
            (CRM, integration or messaging account) were rejected. `message` has
            details.

            - `provider_not_api_key`: This CRM uses OAuth, not API-key connect.
        '401':
          description: >-
            - `invalid_api_key`: The API key is unknown, revoked or expired, or
            its workspace was deleted.

            - `unauthorized`: No `Authorization: Bearer` header, or an empty
            token.
        '403':
          description: >-
            - `api_key_not_scoped`: A key issued without scopes was used outside
            `/v1`.

            - `api_key_owner_inactive`: The member the key acts for was removed
            or suspended.

            - `forbidden`: The key lacks the permission named in
            `requiredPermission`, or the resource belongs to another workspace.

            - `workspace_pending_approval`: The workspace has not been approved
            yet.

            - `workspace_suspended`: The workspace is suspended.
        '404':
          description: >-
            - `crm_resource_not_found`: The CRM returned not found.

            - `not_found`: The resource does not exist in your workspace, or the
            feature is not enabled for it.

            - `unknown_crm`: CRM slug not recognised.
        '413':
          description: >-
            - `internal_error`: An unexpected error. A `400` with this code
            usually means the body is not valid JSON; a `413` means the body is
            larger than 1 MB.
        '429':
          description: '- `rate_limited`: Too many requests.'
        '500':
          description: >-
            - `internal_error`: An unexpected error. A `400` with this code
            usually means the body is not valid JSON; a `413` means the body is
            larger than 1 MB.
        '502':
          description: >-
            - `crm_upstream_error`: Unexpected CRM response.

            - `crm_upstream_unavailable`: CRM unreachable.

            - `provider_error`: The calling service rejected the request
            (`upstreamStatus` 4xx) or was unavailable (5xx).
        '503':
          description: '- `database_unavailable`: The service is temporarily unavailable.'
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Your API key, e.g. `pk_live_xxxxxxxxxxxxxxxxxxxxxxxx`.

````

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