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

# Add a person to a client

> Adds a person to a client, such as a partner or a dependant by name alone. Nobody is invited: use invite_client for that. A dependant cannot have an email. Role primary makes them the primary person, and whoever was primary becomes partner (in a couple) or other. A client holds up to 10 people. Refused with client_archived on an archived client. Returns the client.



## OpenAPI

````yaml /openapi/advisor.json post /clients/{client}/people
openapi: 3.1.0
info:
  title: Redbark Advisor API
  version: 2.0.0
  description: >-
    Read and write access to one advice firm in Redbark Advisor: clients,
    checklists, documents, money, messages, reports, team and webhooks. Send an
    API key or a connected app’s access token as a bearer token. A credential
    carries scopes, one read and one write per area, and each call says the
    scope it needs. A write scope brings its read scope. Each key may make 120
    requests a minute.
servers:
  - url: https://advisor.redbark.com/api/v1
security:
  - bearerAuth: []
tags:
  - name: Firm
    description: The firm, its name and its branding.
  - name: Team
    description: Team members and their roles.
  - name: Clients
    description: Clients, their people and portal invites.
  - name: Checklists
    description: Checklist templates, the checklists sent to clients and their answers.
  - name: Documents
    description: Documents clients upload and the details read from them.
  - name: Money
    description: Bank connections, accounts, balances and transactions.
  - name: Document types
    description: Document types, their fields and the client facts they fill.
  - name: Forms
    description: Forms filled for clients, their values, and the firm’s Forms library.
  - name: Messages
    description: Messages between the firm and clients.
  - name: Reports
    description: Reports exported for clients.
  - name: Meetings
    description: Client meetings, their agendas, transcripts, File notes and actions.
  - name: Webhooks
    description: Webhook endpoints and their deliveries.
  - name: Webhook events
    description: Events sent to your webhook endpoints.
paths:
  /clients/{client}/people:
    post:
      tags:
        - Clients
      summary: Add a person to a client
      description: >-
        Adds a person to a client, such as a partner or a dependant by name
        alone. Nobody is invited: use invite_client for that. A dependant cannot
        have an email. Role primary makes them the primary person, and whoever
        was primary becomes partner (in a couple) or other. A client holds up to
        10 people. Refused with client_archived on an archived client. Returns
        the client.
      operationId: add_client_person
      parameters:
        - name: client
          in: path
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 60
            description: The client id, from list_clients.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 120
                role:
                  type: string
                  enum:
                    - primary
                    - partner
                    - dependant
                    - other
                  description: >-
                    primary (the main person; a client has exactly one),
                    partner, dependant (no email, never invited to the portal)
                    or other.
                email:
                  anyOf:
                    - anyOf:
                        - type: string
                          maxLength: 254
                          description: An email address.
                        - type: 'null'
                    - type: 'null'
                phone:
                  anyOf:
                    - anyOf:
                        - type: string
                          maxLength: 30
                          description: >-
                            A phone number, such as 0412 345 678 or +61 412 345
                            678.
                        - type: 'null'
                    - type: 'null'
              required:
                - name
                - role
      responses:
        '201':
          description: Created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Client'
        '400':
          description: The request is not valid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: The API key or access token is missing, wrong, expired or revoked.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '402':
          description: >-
            subscription_required: the firm has no active subscription, so it
            cannot add or invite clients or send checklists. plan_seat_limit:
            the firm’s plan has no room for the change, such as a second advisor
            on Solo or a 21st team member on Firm.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: >-
            The credential lacks the scope this call needs, the call is for
            admins only, or the member it acts as has left the firm.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No such resource in this firm.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: >-
            The resource is in a state that does not allow this, such as an
            archived client.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '413':
          description: The request body is too large.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Too many requests. See the Retry-After header.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Something went wrong on our side. Try again.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth:
            - clients:write
components:
  schemas:
    Client:
      type: object
      properties:
        object:
          type: string
          enum:
            - client
        id:
          type: string
        name:
          type: string
        kind:
          type: string
          enum:
            - individual
            - couple
            - company
            - trust
            - smsf
        status:
          type: string
          enum:
            - not_invited
            - invited
            - active
            - archived
        advisor_name:
          anyOf:
            - type: string
            - type: 'null'
        people:
          type: array
          items:
            $ref: '#/components/schemas/ClientPerson'
        created_at:
          type: string
          description: An ISO 8601 time in UTC.
        invited_at:
          anyOf:
            - type: string
              description: An ISO 8601 time in UTC.
            - type: 'null'
        joined_at:
          anyOf:
            - type: string
              description: An ISO 8601 time in UTC.
            - type: 'null'
        archived_at:
          anyOf:
            - type: string
              description: An ISO 8601 time in UTC.
            - type: 'null'
        last_activity_at:
          type: string
          description: An ISO 8601 time in UTC.
      required:
        - object
        - id
        - name
        - kind
        - status
        - advisor_name
        - people
        - created_at
        - invited_at
        - joined_at
        - archived_at
        - last_activity_at
      additionalProperties: true
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - invalid_request_error
                - authentication_error
                - permission_error
                - rate_limit_error
                - api_error
            code:
              type: string
            message:
              type: string
            param:
              anyOf:
                - type: string
                - type: 'null'
            request_id:
              type: string
          required:
            - type
            - code
            - message
            - param
            - request_id
          additionalProperties: true
      required:
        - error
      additionalProperties: true
    ClientPerson:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        role:
          type: string
          enum:
            - primary
            - partner
            - dependant
            - other
          description: >-
            primary (the main person; a client has exactly one), partner,
            dependant (no email, never invited to the portal) or other.
        email:
          anyOf:
            - type: string
            - type: 'null'
        phone:
          anyOf:
            - type: string
            - type: 'null'
        invited_at:
          anyOf:
            - type: string
              description: An ISO 8601 time in UTC.
            - type: 'null'
        joined_at:
          anyOf:
            - type: string
              description: An ISO 8601 time in UTC.
            - type: 'null'
      required:
        - id
        - name
        - role
        - email
        - phone
        - invited_at
        - joined_at
      additionalProperties: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        A firm API key, shown once when it is made, or a connected app’s OAuth
        access token. Each operation lists the scope it needs, such as
        clients:write.

````

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