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

> Creates a new person in the workspace.

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



## OpenAPI

````yaml /en/api-reference/openapi.json post /v1/people
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/people:
    post:
      tags:
        - People
      summary: Create a person
      description: |-
        Creates a new person in the workspace.

        <Accordion title="Required scope">
        `people:write`
        </Accordion>
      operationId: createPerson
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePersonRequest'
      responses:
        '201':
          description: Person created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PersonWithEmbeddedResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/InsufficientScope'
        '422':
          $ref: '#/components/responses/ValidationError'
        '429':
          $ref: '#/components/responses/RateLimitExceeded'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  schemas:
    CreatePersonRequest:
      type: object
      required:
        - full_name
      properties:
        full_name:
          type: string
          maxLength: 70
          example: Maria Silva
        emails:
          type: array
          items:
            $ref: '#/components/schemas/ContactEmail'
        phones:
          type: array
          items:
            $ref: '#/components/schemas/ContactPhone'
        company_id:
          type: string
          format: uuid
        position:
          type: string
          maxLength: 100
          example: Sales Director
        owner_email:
          type: string
          format: email
          description: >-
            Email of the workspace member to set as owner. The API resolves it
            to the internal user ID. Must be a member of this workspace.
          example: joao@company.com
        avatar_image:
          type: string
          description: >-
            Public HTTPS URL or full base64 data URI of the image (e.g.
            `data:image/png;base64,...`). Accepted formats: JPEG, PNG, WebP,
            GIF, BMP, TIFF.
          example: data:image/png;base64,iVBORw0KGgo...
        tags:
          type: array
          items:
            type: string
            minLength: 1
            maxLength: 30
          description: >-
            Tag names (keys) to associate with the person. If a tag doesn't
            exist, it will be automatically created.
        list_ids:
          type: array
          items:
            type: string
            format: uuid
          description: List IDs to associate with the person.
        custom_fields:
          type: array
          items:
            type: object
            required:
              - field_key
              - value
            properties:
              field_key:
                type: string
                maxLength: 35
                example: lead_source
                description: >-
                  Key of the custom field (e.g. `lead_source`). If no field with
                  this key exists in the workspace, it is created automatically
                  with type `text`.
              value:
                type: string
                description: Field value as a string.
          description: >-
            Custom field values to set for the person. Identified by
            `field_key`. If the field does not exist, it is created
            automatically with type `text`.
    PersonWithEmbeddedResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/PersonWithEmbedded'
    ContactEmail:
      type: object
      required:
        - email
      properties:
        email:
          type: string
          format: email
          example: contact@acme.com
        type:
          type: string
          enum:
            - personal
            - work
            - other
          description: Email type.
          example: work
    ContactPhone:
      type: object
      required:
        - phone
      properties:
        phone:
          type: string
          example: '+551130000000'
        type:
          type: string
          enum:
            - mobile
            - work
            - residential
            - other
          description: Phone type.
          example: work
    PersonWithEmbedded:
      allOf:
        - $ref: '#/components/schemas/Person'
        - type: object
          properties:
            company:
              type: object
              nullable: true
              properties:
                id:
                  type: string
                  format: uuid
                full_name:
                  type: string
                emails:
                  type: array
                  nullable: true
                  items:
                    type: object
                    properties:
                      email:
                        type: string
                      type:
                        type: string
                phones:
                  type: array
                  nullable: true
                  items:
                    type: object
                    properties:
                      phone:
                        type: string
                      type:
                        type: string
                avatar_url:
                  type: string
                  nullable: true
                entity_id:
                  type: string
                created_at:
                  type: string
                  format: date-time
                updated_at:
                  type: string
                  format: date-time
            tags:
              type: array
              items:
                $ref: '#/components/schemas/Tag'
            lists:
              type: array
              items:
                $ref: '#/components/schemas/ContactList'
            custom_fields:
              type: array
              items:
                $ref: '#/components/schemas/CustomFieldValue'
    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
    Person:
      type: object
      properties:
        id:
          type: string
          format: uuid
        full_name:
          type: string
          maxLength: 70
          example: Maria Silva
        emails:
          type: array
          nullable: true
          items:
            $ref: '#/components/schemas/ContactEmail'
          example:
            - email: maria@company.com
              type: work
        phones:
          type: array
          nullable: true
          items:
            $ref: '#/components/schemas/ContactPhone'
          example:
            - phone: '+5511999990001'
              type: mobile
        company_id:
          type: string
          format: uuid
          nullable: true
        owner:
          $ref: '#/components/schemas/Owner'
        position:
          type: string
          nullable: true
          example: Sales Director
        score:
          type: number
          minimum: 0
          maximum: 5
          example: 0
          readOnly: true
          description: Read-only. Managed internally by Vendaze.
        avatar_url:
          type: string
          format: uri
          nullable: true
          example: >-
            https://storage.vendaze.com/client/workspaces/abc/people/xyz/avatar/avatar_WWT1BGs9ma.webp
        entity_id:
          type: string
          example: g7wwkh0
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    Tag:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier of the tag.
        name:
          type: string
          maxLength: 30
          description: Display name of the tag.
          example: Hot Lead
        key:
          type: string
          maxLength: 30
          description: >-
            Unique key within the workspace. Lowercase letters, digits, and
            underscores only (e.g. `hot_lead`). Used to reference the tag in
            association arrays.
          example: hot_lead
        color_text:
          type: string
          nullable: true
          pattern: ^#[0-9a-fA-F]{6}$
          description: >-
            Text color in hex RGB format. `null` means the workspace default is
            applied.
          example: '#ffffff'
        color_background:
          type: string
          nullable: true
          pattern: ^#[0-9a-fA-F]{6}$
          description: >-
            Background color in hex RGB format. `null` means the workspace
            default is applied.
          example: '#ef4444'
        created_at:
          type: string
          format: date-time
          description: ISO 8601 UTC timestamp of when the tag was created.
    ContactList:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        created_at:
          type: string
          format: date-time
    CustomFieldValue:
      type: object
      properties:
        id:
          type: string
          format: uuid
        value: {}
        field:
          type: object
          properties:
            id:
              type: string
              format: uuid
            label:
              type: string
            key:
              type: string
            type:
              type: string
    Owner:
      type: object
      nullable: true
      description: >-
        Workspace member responsible for this task. `null` when no owner is
        assigned.
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
          example: John Smith
        email:
          type: string
          format: email
          example: john@company.com
  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
    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.

````