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

# Create a page



## OpenAPI

````yaml /openapi.yaml post /workspaces/{workspace}/pages
openapi: 3.1.0
info:
  title: Contact Button API
  version: 1.0.0-alpha.1
  description: >
    API-first management and public agent actions for Contact Buttons and
    button.contact pages.

    API v1 is the first public contract. Existing private legacy API and browser
    workflows remain supported.
  contact:
    name: Contact Button
    url: https://learn.contactbutton.com
servers:
  - url: https://api.contactbutton.com/v1
    description: Production (canonical)
  - url: https://app.contactbutton.com/v1
    description: Backwards-compatible application-domain alias
security:
  - bearerAuth: []
tags:
  - name: Onboarding
    description: Human-verified agent onboarding.
  - name: Workspaces
  - name: Team
  - name: Pages
  - name: Domains
  - name: Buttons
  - name: Forms
  - name: Surveys
  - name: Apps
  - name: Knowledge
  - name: Booking
  - name: Telephony
    description: >-
      Bring-your-own-Telnyx setup, call flows, phone numbers, and voice
      interactions.
  - name: Reviews
    description: >-
      Send consented review requests through workspace-owned email, SMS, and
      WhatsApp channels.
  - name: Commerce
  - name: Engagement inbox
  - name: Public actions
    description: Public, rate-limited actions that may require human confirmation.
paths:
  /workspaces/{workspace}/pages:
    parameters:
      - $ref: '#/components/parameters/WorkspaceId'
    post:
      tags:
        - Pages
      summary: Create a page
      operationId: createPage
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/PageInput'
                - type: object
                  required:
                    - name
                    - slug
      responses:
        '201':
          $ref: '#/components/responses/Data'
        '422':
          $ref: '#/components/responses/Problem'
components:
  parameters:
    WorkspaceId:
      name: workspace
      in: path
      required: true
      schema:
        type: string
        format: uuid
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: false
      description: Stable 8–120 character key for safe mutation retries.
      schema:
        type: string
        minLength: 8
        maxLength: 120
  schemas:
    PageInput:
      type: object
      properties:
        name:
          type: string
          maxLength: 255
        slug:
          type: string
          pattern: ^[a-z0-9_-]+$
        published:
          type: boolean
        publish_destination:
          type: string
          enum:
            - button_contact
            - custom
        display_name:
          type: string
        bio:
          type: string
          maxLength: 500
        seo_title:
          type: string
        seo_description:
          type: string
        aeo_summary:
          type: string
        agent_instructions:
          type: string
          maxLength: 2000
        chat:
          $ref: '#/components/schemas/NativeChatInput'
        schema_type:
          type: string
          enum:
            - WebPage
            - ProfilePage
            - ContactPage
            - AboutPage
            - Organization
            - LocalBusiness
            - Service
        robots_index:
          type: boolean
          default: true
        llms_enabled:
          type: boolean
          default: true
    NativeChatInput:
      type: object
      properties:
        greeting:
          type: string
          maxLength: 500
        suggested_replies:
          type: array
          maxItems: 6
          items:
            $ref: '#/components/schemas/SuggestedReplyInput'
    DataResponse:
      type: object
      required:
        - data
        - meta
      properties:
        data: {}
        meta:
          type: object
          properties:
            request_id:
              type: string
            next_cursor:
              type:
                - string
                - 'null'
    Problem:
      type: object
      required:
        - type
        - title
        - status
        - detail
        - instance
        - request_id
      properties:
        type:
          type: string
          format: uri
        title:
          type: string
        status:
          type: integer
        detail:
          type: string
        instance:
          type: string
        request_id:
          type: string
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
    SuggestedReplyInput:
      type: object
      description: >-
        A typed Contact Button action. Legacy operation-only replies remain
        supported as native chat actions.
      required:
        - id
        - label
        - event_label
      properties:
        id:
          type: string
          format: uuid
        kind:
          type: string
          enum:
            - answer_link
            - call
            - callback
            - contact_form
            - email
            - extra_action
            - faq
            - get_quote
            - question
            - browse
            - link_url
            - app_widget
            - livechat
            - newsletter
            - schedule_meeting
            - schedule_video_call
            - video
            - video_call
            - whatsapp
            - whatsapp_form
        label:
          type: string
          maxLength: 120
        message:
          type: string
          maxLength: 10000
        featured:
          type: boolean
          default: false
        event_label:
          type: string
          maxLength: 80
        operation:
          type: string
          enum:
            - message
            - request_human
          default: message
        action:
          $ref: '#/components/schemas/SuggestedReplyAction'
    SuggestedReplyAction:
      type: object
      required:
        - type
      properties:
        type:
          type: string
          enum:
            - native_chat
            - request_human
            - url
            - app_widget
            - popup
        target:
          type:
            - string
            - 'null'
          description: >-
            An http(s), tel, or mailto URL; an installed app public ID; or a
            popup external ID, depending on type.
        new_tab:
          type: boolean
          default: false
          description: Applies only to http(s) URL actions.
  responses:
    Data:
      description: Successful data envelope.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/DataResponse'
    Problem:
      description: RFC 9457-style problem details.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Sanctum personal access token
      description: >
        A Contact Button scoped bearer key. Send `Authorization: Bearer
        <token>`.

        Token abilities are enforced independently of workspace membership; both
        checks must pass.

        OAuth 2.0 authorization-code flows are not currently available.
      x-contact-button-token-abilities:
        workspaces:read: Read workspaces, teams, domains, settings, and connections.
        workspaces:write: >-
          Create and manage workspaces, teams, domains, settings, and
          connections.
        content:read: Read buttons, forms, lists, pages, booking types, and knowledge.
        content:write: Create, update, publish, and remove content.
        engagements:read: >-
          Read submissions, subscribers, bookings, callbacks, calls, reviews,
          and conversations.
        engagements:manage: Reply to and manage engagement records.
        actions:request: Request protected actions that can still require human confirmation.

````

## Related topics

- [Pages and custom domains](/guides/pages-domains.md)
- [Create a button](/api-reference/buttons/create-a-button.md)
- [Agent onboarding](/agents/onboarding.md)
- [Authentication](/authentication.md)
- [API quickstart](/quickstart.md)
