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

# Create a client workspace

> Creates a workspace for a new client. Agency owners and admins only; billing starts at the first launch.

Permission: `agency:manage`

[Read the recovery rules](https://docs.emailx.ai/en/api-reference/idempotency.md) before retrying a write. Keep the same key and body for the same logical operation.


## OpenAPI

````yaml openapi/emailx.en.json POST /agency/workspaces
openapi: 3.0.3
info:
  title: Emailx API
  version: 1.0.0-beta
  description: >-
    Customer and agency integrations for Emailx. Beta access is operator-issued.
    The v1 beta supports bounded People CSV/XLSX imports, saved email-template
    settings, selected email generation with explicit AI-credit confirmation,
    exact-message approval, reviewed email activation for native scheduled
    sending, and explicitly confirmed inbox replies bound to saved context when
    host capabilities permit. Inbox context is bounded and may be incomplete or
    stale; no provider refresh occurs. Manual LinkedIn imports, reviewed
    activation and reviewed resume of paused campaigns are separate gated
    workflows. Reply drafts, knowledge, team, infrastructure quotes with hosted
    checkout and agency administration are covered by separate scopes. Signed
    webhooks report durable operation outcomes. It does not support immediate
    batches or direct card charges.
servers:
  - url: https://app.emailx.ai/api/v1
    description: Emailx application · access must be enabled
security: []
tags:
  - name: Getting started
  - name: Workspaces
  - name: Contacts
  - name: Templates
  - name: Campaigns
  - name: Inbox
  - name: Senders
  - name: Team
  - name: Analytics
  - name: Imports
  - name: Operations
  - name: Knowledge
  - name: Infrastructure
  - name: Agency
paths:
  /agency/workspaces:
    post:
      tags:
        - Agency clients
      summary: Create a client workspace
      description: >-
        Creates a workspace for a new client. Agency owners and admins only;
        billing starts at the first launch.


        Permission: `agency:manage`
      operationId: create_api_agency_workspace
      parameters:
        - name: Idempotency-Key
          in: header
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 128
            pattern: ^[A-Za-z0-9_.:/-]+$
          description: Unique per logical mutation. Same path and body replay for 24 hours.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAgencyWorkspace'
            example:
              name: Example Client
              website: https://example.com
              plan: linkedin
              senders: 1
      responses:
        '201':
          description: Created
          headers:
            X-Request-Id:
              schema:
                type: string
            Emailx-Api-Version:
              schema:
                type: string
            X-RateLimit-Limit:
              schema:
                type: string
            X-RateLimit-Remaining:
              schema:
                type: string
            X-RateLimit-Reset:
              schema:
                type: string
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/AgencyWorkspace'
                required:
                  - data
              example:
                data:
                  workspace_id: 1
                  agency_workspace_id: 1
                  name: example
                  status: example
        '400':
          description: Request error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Invalid, expired or revoked API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Insufficient scope or write permission
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Resource missing or inaccessible
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: Conflict, concurrent request or uncertain original result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          headers:
            Retry-After:
              schema:
                type: string
              description: Seconds to wait when present.
        '413':
          description: Request error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '415':
          description: Request error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limited; respect Retry-After
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          headers:
            Retry-After:
              schema:
                type: string
              description: Seconds to wait when present.
        '500':
          description: Request error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: API disabled, request storage unavailable or feature not enabled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          headers:
            Retry-After:
              schema:
                type: string
              description: Seconds to wait when present.
      security:
        - BearerAuth: []
      x-codeSamples:
        - lang: cURL
          source: |-
            curl -X POST "https://app.emailx.ai/api/v1/agency/workspaces" \
              -H "Authorization: Bearer $EMAILX_API_KEY" \
              -H "Content-Type: application/json" \
              -H "Idempotency-Key: example-operation-001" \
              --data '{"name":"Example Client","website":"https://example.com","plan":"linkedin","senders":1}'
        - lang: Python
          source: |-
            import os, requests

            response = requests.post(
                "https://app.emailx.ai/api/v1/agency/workspaces",
                headers={"Authorization": "Bearer " + os.environ["EMAILX_API_KEY"], "Idempotency-Key": "example-operation-001"},
                json={'name': 'Example Client', 'website': 'https://example.com', 'plan': 'linkedin', 'senders': 1},
                timeout=30,
            )
            response.raise_for_status()
            print(response.json())
        - lang: JavaScript
          source: >-
            const response = await
            fetch("https://app.emailx.ai/api/v1/agency/workspaces", {
              method: "POST",
              headers: { Authorization: `Bearer ${process.env.EMAILX_API_KEY}`, "Content-Type": "application/json", "Idempotency-Key": "example-operation-001" },
              body: JSON.stringify({"name": "Example Client", "website": "https://example.com", "plan": "linkedin", "senders": 1}),
              signal: AbortSignal.timeout(30000),
            });

            if (!response.ok) throw new Error(`Emailx: ${response.status}`);

            console.log(await response.json());
components:
  schemas:
    CreateAgencyWorkspace:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 255
        website:
          type: string
          maxLength: 500
        contact_email:
          type: string
          format: email
          maxLength: 255
        plan:
          type: string
          maxLength: 60
        emails:
          type: integer
          minimum: 0
        senders:
          type: integer
          minimum: 0
      required:
        - name
      additionalProperties: false
      description: >-
        Agency owners and admins only. Non-prepaid agencies must pick a plan;
        billing starts at first launch.
    AgencyWorkspace:
      type: object
      properties:
        workspace_id:
          type: integer
          minimum: 1
        agency_workspace_id:
          type: integer
          minimum: 1
        name:
          type: string
          nullable: true
        status:
          type: string
        color:
          type: string
          nullable: true
        contact_email:
          type: string
          nullable: true
        created_at:
          type: string
          nullable: true
          format: date-time
        billing_starts:
          type: string
          enum:
            - at_first_launch
        api_grant_required:
          type: boolean
          enum:
            - true
        client_research_started:
          type: boolean
          enum:
            - false
      required:
        - workspace_id
        - agency_workspace_id
        - name
        - status
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            request_id:
              type: string
            details:
              type: object
              additionalProperties: true
          required:
            - code
            - message
            - request_id
      required:
        - error
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        ex_test_ or ex_live_ key issued by an Emailx operator. Never use
        provider keys or session cookies.

````

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