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

# Create a product

> Creates a new product in the workspace.

<Accordion title="Required scope">
`products:write`
</Accordion>



## OpenAPI

````yaml /en/api-reference/openapi.json post /v1/products
openapi: 3.1.0
info:
  title: OAuth 2.1
  description: Endpoints for registering applications and managing OAuth 2.1 tokens.
  version: 1.0.0
  contact:
    name: Vendaze Support
    email: suporte@vendaze.com
servers:
  - url: https://api.vendaze.com
    description: Production
security:
  - bearerAuth: []
tags:
  - name: OAuth
  - name: People
  - name: Companies
  - name: Deals
  - name: Pipelines
  - name: Tasks
  - name: Task Types
  - name: Products
  - name: Tags
  - name: Lists
  - name: Custom Fields
  - name: Webhooks
paths:
  /v1/products:
    post:
      tags:
        - Products
      summary: Create a product
      description: |-
        Creates a new product in the workspace.

        <Accordion title="Required scope">
        `products:write`
        </Accordion>
      operationId: createProduct
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateProductRequest'
      responses:
        '201':
          description: Product created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/InsufficientScope'
        '409':
          $ref: '#/components/responses/Conflict'
        '422':
          $ref: '#/components/responses/ValidationError'
        '429':
          $ref: '#/components/responses/RateLimitExceeded'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  schemas:
    CreateProductRequest:
      type: object
      required:
        - name
        - currency
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 80
          description: Product name.
          example: Enterprise Plan
        currency:
          $ref: '#/components/schemas/CurrencyCode'
        price_cts:
          type: integer
          minimum: 0
          maximum: 1000000000000000
          description: Price in the smallest currency unit. Defaults to `0`.
          example: 99900
        description:
          type: string
          maxLength: 1000
          description: Product description.
          example: Full-featured plan for large teams.
        code:
          type: string
          maxLength: 60
          description: Internal product code or SKU.
          example: PLAN-ENT
        is_active:
          type: boolean
          description: Whether the product is active. Defaults to `true`.
          example: true
        billing_cycle:
          type: string
          enum:
            - one_time
            - monthly
            - quarterly
            - annually
          description: Billing cycle. Defaults to `one_time`.
          example: monthly
        image:
          type: string
          description: >-
            Product image. Accepts a public HTTPS URL, a raw Base64 string, or a
            full data URI (`data:image/png;base64,...`). Maximum 2 MB.
          example: https://example.com/product.png
    ProductResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Product'
    CurrencyCode:
      type: string
      description: ISO 4217 currency code supported by Vendaze.
      enum:
        - AED
        - ARS
        - AUD
        - BRL
        - CAD
        - CHF
        - CLP
        - CNY
        - COP
        - DKK
        - EGP
        - EUR
        - GBP
        - HKD
        - ILS
        - INR
        - JPY
        - KWD
        - MAD
        - MXN
        - MYR
        - NGN
        - NOK
        - NZD
        - PEN
        - QAR
        - SAR
        - SEK
        - SGD
        - TRY
        - USD
        - UYU
        - ZAR
      example: USD
    Product:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier.
        name:
          type: string
          maxLength: 80
          description: Product name.
          example: Enterprise Plan
        price_cts:
          type: integer
          description: Price in the smallest currency unit (e.g. cents). `99900` = $999.00.
          example: 99900
        currency:
          $ref: '#/components/schemas/CurrencyCode'
        description:
          type: string
          nullable: true
          maxLength: 1000
          description: Optional product description.
          example: Full-featured plan for large teams.
        image_url:
          type: string
          nullable: true
          description: Public URL of the product image, or `null` if none.
          example: >-
            https://storage.vendaze.com/client/workspaces/abc/products/xyz/image/avatar_Ab1Cd2Ef3G.webp
        code:
          type: string
          nullable: true
          maxLength: 60
          description: Internal product code or SKU.
          example: PLAN-ENT
        is_active:
          type: boolean
          description: Whether the product is active.
          example: true
        billing_cycle:
          type: string
          enum:
            - one_time
            - monthly
            - quarterly
            - annually
          description: Billing cycle for the product.
          example: monthly
        created_at:
          type: string
          format: date-time
          description: ISO 8601 UTC creation timestamp.
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            request_id:
              type: string
              format: uuid
    ValidationErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: validation_error
            message:
              type: string
              example: Validation failed.
            fields:
              type: object
              additionalProperties:
                type: string
            request_id:
              type: string
              format: uuid
  responses:
    BadRequest:
      description: 'Malformed request body or empty update. Error code: `bad_request`.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: bad_request
              message: Request body must be valid JSON.
              request_id: 550e8400-e29b-41d4-a716-446655440000
    Unauthorized:
      description: >-
        Token missing, invalid, or expired. Possible error codes:
        `unauthorized`, `token_expired`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: unauthorized
              message: Missing or invalid Authorization header.
              request_id: 550e8400-e29b-41d4-a716-446655440000
    InsufficientScope:
      description: 'Token lacks the required scope. Error code: `insufficient_scope`.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: insufficient_scope
              message: This endpoint requires the 'webhooks:read' scope.
              request_id: 550e8400-e29b-41d4-a716-446655440000
    Conflict:
      description: >-
        A custom field with the same `key` already exists. Error code:
        `conflict`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: conflict
              message: A record with this value already exists.
              fields:
                key: Value already in use.
              request_id: 550e8400-e29b-41d4-a716-446655440000
    ValidationError:
      description: >-
        Input validation failed. Error code: `validation_error`. The `fields`
        object maps each invalid field to a description of the problem.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ValidationErrorResponse'
          example:
            error:
              code: validation_error
              message: Validation failed.
              fields:
                url: url must use HTTPS.
                events: At least one event is required.
              request_id: 550e8400-e29b-41d4-a716-446655440000
    RateLimitExceeded:
      description: 'Rate limit exceeded. Error code: `rate_limit_exceeded`.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: rate_limit_exceeded
              message: Rate limit exceeded. Try again in 60 seconds.
              request_id: 550e8400-e29b-41d4-a716-446655440000
    InternalError:
      description: 'Unexpected server error. Error code: `internal_error`.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: internal_error
              message: An unexpected error occurred.
              request_id: 550e8400-e29b-41d4-a716-446655440000
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: OAuth 2.1 access token.

````