> ## Documentation Index
> Fetch the complete documentation index at: https://kiflo-b3d3c9c0.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Start a collaboration

> Start a collaboration with a partner on an account mapping overlap between one of your accounts and one of the partner's accounts.
The context is saved as a public note on the collaboration, so the partner can read it.
This endpoint requires a HubSpot-issued access token: the collaboration is owned by and attributed to the user that token was issued for, which a Public API key does not identify.



## OpenAPI

````yaml /openapi.json post /v3/account-mapping/collaborations
openapi: 3.0.1
info:
  title: Kiflo Public API v3
  description: "The Kiflo API allows you to have control over your integration and create the best experiences.\r\n\r\n***\r\n\r\n## Format\r\n\r\nThe API follows the REST standard using JSON to format requests and responses.  \r\nDecimals are formatted using invariant culture, ie: using \".\" (dot) as a decimal sperator and no thousands separator.  \r\nDates are formatted using ISO standards, in UTC format, including the timezone. Ex:  2015-03-25T12:00:00Z\r\n\r\n***\r\n\r\n## Security\r\n\r\nThe API is secured using an API token.\r\n\r\n**How to generate an API Access Token**  \r\n 1. Open your [account settings page](https://app.kiflo.com/account/integration)\r\n 2. Go to the \"API Access Token\" section\r\n 3. Click \"Add\" button\r\n 4. Choose a name that will be used to identify the token and click \"Add\"\r\n 4. Copy the generate token\r\n   \r\n> **Note:** For security reason, the generated API Access Token won't be visible after you close the settings page. Be sure to copy the generated token otherwise you won't be able to get it later.\r\n  \r\n**How to authenticate on the API**  \r\n  \r\nTo authenticate on the API, send the generated token in the Authorization header using the Bearer scheme:  \r\n`Authorization: Bearer #YOUR_GENERATED_TOKEN_HERE#`\r\n"
  version: v3
servers: []
security: []
paths:
  /v3/account-mapping/collaborations:
    post:
      tags:
        - AccountMappingCollaborations
      summary: Start a collaboration
      description: "Start a collaboration with a partner on an account mapping overlap between one of your accounts and one of the partner's accounts.\r\nThe context is saved as a public note on the collaboration, so the partner can read it.\r\nThis endpoint requires a HubSpot-issued access token: the collaboration is owned by and attributed to the user that token was issued for, which a Public API key does not identify."
      requestBody:
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/AccountMappingCollaborationStartRequestDto'
          application/json:
            schema:
              $ref: '#/components/schemas/AccountMappingCollaborationStartRequestDto'
          text/json:
            schema:
              $ref: '#/components/schemas/AccountMappingCollaborationStartRequestDto'
          application/*+json:
            schema:
              $ref: '#/components/schemas/AccountMappingCollaborationStartRequestDto'
      responses:
        '200':
          description: Collaboration started
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountMappingCollaborationDto'
              example:
                id: 128
                name: Acme Corporation x Globex Partners
                status: New
                partnerId: 7
                tenantAccountId: 1
                partnerAccountId: 42
                ownerUserId: 315
                assignedUserId: 964
                creationDate: '2026-04-22T10:06:00Z'
        '400':
          description: Invalid request
        '403':
          description: >-
            The access token was not issued by HubSpot, the account mapping
            feature is not available, or the user cannot start collaborations
      security:
        - oauth2:
            - AccountMappingCollaboration.Create
            - HubSpot
components:
  schemas:
    AccountMappingCollaborationStartRequestDto:
      type: object
      properties:
        accountId:
          type: integer
          description: The ID of your account on the overlap.
          format: int32
        overlappingAccountId:
          type: integer
          description: >-
            The ID of the partner's account overlapping
            Resels.Backend.Api.Public.Model.AccountMappingCollaborations.v3.AccountMappingCollaborationStartRequestDto.AccountId.
          format: int32
        context:
          type: string
          description: >-
            The context shared with the partner, saved as a public note on the
            collaboration. Required.
          nullable: true
        assignedUserId:
          type: integer
          description: >-
            The ID of the Kiflo user of the partner team member assigned to the
            collaboration. Optional.
          format: int32
          nullable: true
      additionalProperties: false
    AccountMappingCollaborationDto:
      type: object
      properties:
        id:
          type: integer
          description: The ID of the collaboration.
          format: int32
        name:
          type: string
          description: >-
            The name of the collaboration, built from your account and the
            partner names.
          nullable: true
        status:
          $ref: '#/components/schemas/CollaborationStatus'
        partnerId:
          type: integer
          description: The ID of the partner the collaboration is started with.
          format: int32
        tenantAccountId:
          type: integer
          description: >-
            The ID of your account on the overlap the collaboration was started
            from.
          format: int32
        partnerAccountId:
          type: integer
          description: >-
            The ID of the partner's account on the overlap the collaboration was
            started from.
          format: int32
        ownerUserId:
          type: integer
          description: The ID of the user owning the collaboration on your side.
          format: int32
          nullable: true
        assignedUserId:
          type: integer
          description: >-
            The ID of the Kiflo user of the partner team member assigned to the
            collaboration.
          format: int32
          nullable: true
        creationDate:
          type: string
          description: The date the collaboration was created, in UTC.
          format: date-time
      additionalProperties: false
    CollaborationStatus:
      enum:
        - Unknown
        - New
        - Accepted
        - Refused
        - Abandoned
        - Closed
        - Converted
      type: string

````