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

# Update a campaign's WhatsApp agent settings

**Required scope:** `whatsapp.edit`, and API keys additionally need `campaigns.edit`.


## OpenAPI

````yaml /api-reference/openapi.json put /whatsapp/campaigns/{id}
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:
  /whatsapp/campaigns/{id}:
    put:
      summary: Update a campaign's WhatsApp agent settings
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                whatsappEnabled:
                  type: boolean
                whatsappSenderId:
                  type: string
                  nullable: true
                whatsappAgentCollectionIds:
                  type: array
                  items:
                    type: string
                whatsappAgentTemplateIds:
                  type: array
                  items:
                    type: string
                recoveryLinkEnabled:
                  type: boolean
                whatsappPaymentLinkEnabled:
                  type: boolean
                whatsappPaymentTemplateId:
                  type: string
                  nullable: true
                paymentLinkBaseUrl:
                  type: string
                  nullable: true
                  maxLength: 2000
              required:
                - whatsappEnabled
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  name:
                    type: string
                  status:
                    type: string
                  agentName:
                    type: string
                    nullable: true
                  whatsappEnabled:
                    type: boolean
                  whatsappSenderId:
                    type: string
                    nullable: true
                  whatsappAgentCollectionIds:
                    type: array
                    items:
                      type: string
                  whatsappAgentTemplateIds:
                    type: array
                    items:
                      type: string
                  recoveryLinkEnabled:
                    type: boolean
                  whatsappPaymentLinkEnabled:
                    type: boolean
                  whatsappPaymentTemplateId:
                    type: string
                    nullable: true
                  paymentLinkBaseUrl:
                    type: string
                    nullable: true
                required:
                  - id
                  - name
                  - status
                  - agentName
                  - whatsappEnabled
                  - whatsappSenderId
                  - whatsappAgentCollectionIds
                  - whatsappAgentTemplateIds
                  - recoveryLinkEnabled
                  - whatsappPaymentLinkEnabled
                  - whatsappPaymentTemplateId
                  - paymentLinkBaseUrl
        '400':
          description: >-
            - `invalid_body`: The request body (or query) failed validation.
            Details are in `issues` (or `detail`). `422` on `POST
            /v1/campaigns/{campaignId}/leads`.

            - `invalid_whatsapp_media_templates`: Some agent templates are not
            approved or have no media.

            - `invalid_whatsapp_payment_template`: Payment template missing, not
            approved, or lacks a payment-link button.
        '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: >-
            - `campaign_not_found`: No campaign with that id in this workspace.

            - `not_found`: The resource does not exist in your workspace, or the
            feature is not enabled for it.
        '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.
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.