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

# Add commissions to a conversion



## OpenAPI

````yaml /api-reference/openapi.json post /conversions/{conversion_id}/commissions/
openapi: 3.0.3
info:
  title: Tapfiliate REST API
  version: '1.6'
  description: >-
    Reference for the Tapfiliate REST API. See the introduction for
    authentication, pagination and rate limits.
  x-generated-from: ApiBlueprint@e23e51f
servers:
  - url: https://api.tapfiliate.com/1.6
    description: Production
security:
  - ApiKey: []
tags:
  - name: Customers
    description: >-
      People who signed up or paid after being referred by an affiliate. With
      recurring or lifetime commissions, later conversions for the same customer
      go to the same affiliate.
  - name: Conversions
    description: >-
      Sales and other actions you pay commissions for. Each conversion has one
      or more commissions.
  - name: Commissions
    description: >-
      What an affiliate earns for a conversion. Approve or disapprove them
      before payout.
  - name: Affiliates
    description: >-
      The partners who promote your programs, with their meta data, notes,
      payout methods and balances.
  - name: Affiliate Groups
    description: Groups for organising your affiliates.
  - name: Affiliate Prospects
    description: >-
      People who signed up through a recruitment source but are not affiliates
      yet.
  - name: Programs
    description: >-
      Your affiliate programs, the affiliates in them and their commission
      settings.
  - name: Payments
    description: Settle affiliate balances and look up past payments.
  - name: Clicks
    description: Visits through affiliate links, the first step of attribution.
paths:
  /conversions/{conversion_id}/commissions/:
    post:
      tags:
        - Conversions
      summary: Add commissions to a conversion
      operationId: addCommissionsToAConversion
      parameters:
        - name: conversion_id
          in: path
          description: Numeric `id` of the conversion to add the commission(s) to.
          required: true
          example: '1'
          schema:
            type: number
      requestBody:
        content:
          application/json:
            example:
              - conversion_sub_amount: 20
                comment: Awesome!
            schema:
              type: object
              required:
                - conversion_sub_amount
              properties:
                conversion_sub_amount:
                  type: number
                  example: 50
                  description: >-
                    The amount on which the commission should be calculated
                    using the supplied, or the program's default commission type
                commission_type:
                  type: string
                  example: mycommissiontype
                  description: >-
                    If no commission type is supplied, the programs default
                    commission type is used
                comment:
                  type: string
                  example: Awesome!
                  description: >-
                    A comment for this commission. The comment will be visible
                    to the affiliate
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: number
                    conversion_sub_amount:
                      type: number
                    amount:
                      type: number
                    commission_type:
                      type: string
                    approved:
                      nullable: true
                    kind:
                      type: string
                    affiliate:
                      type: object
                      properties:
                        id:
                          type: string
                        firstname:
                          type: string
                        lastname:
                          type: string
                    currency:
                      type: string
                    created_at:
                      type: string
                    payout:
                      nullable: true
                    comment:
                      type: string
                      nullable: true
                    final:
                      nullable: true
                    commission_name:
                      type: string
                  required:
                    - id
                    - conversion_sub_amount
                    - amount
                    - commission_type
                    - approved
                    - kind
                    - affiliate
                    - currency
                    - created_at
                    - payout
                    - comment
                    - final
                    - commission_name
              example:
                - id: 3
                  conversion_sub_amount: 20
                  amount: 2
                  commission_type: standard
                  approved: null
                  kind: regular
                  affiliate:
                    id: janejameson
                    firstname: Jane
                    lastname: Jameson
                  currency: USD
                  created_at: 2021-03-03T12:39:19+0000
                  payout: null
                  comment: Awesome!
                  final: null
                  commission_name: standard
                - id: 4
                  conversion_sub_amount: 20
                  amount: 1
                  commission_type: level-2
                  approved: null
                  kind: level
                  affiliate:
                    id: sandrasanderson
                    firstname: Sandra
                    lastname: Sanderson
                  currency: USD
                  created_at: 2021-03-03T12:39:19+0000
                  payout: null
                  comment: null
                  final: null
                  commission_name: Level 2
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  responses:
    BadRequest:
      description: The request is invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorList'
          example:
            errors:
              - message: Missing mandatory parameter(s)
    Unauthorized:
      description: The API key is missing or wrong
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RequestError'
          example:
            message: Authentication Failed.
            code: 401
    Forbidden:
      description: No API access or no permission for this action
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RequestError'
          example:
            message: Forbidden
            code: 403
            traceId: 04ed655728a22bc0d39f
    NotFound:
      description: The object does not exist or belongs to another account
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RequestError'
          example:
            message: Not Found
            code: 404
            traceId: 7ae8e92b77572da03805
  schemas:
    ErrorList:
      type: object
      description: Business and validation errors raised by an endpoint.
      properties:
        errors:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
              code:
                type: string
                description: Machine-readable code, on 409 responses.
              property_path:
                type: string
                description: The invalid field, on validation errors.
            required:
              - message
      required:
        - errors
    RequestError:
      type: object
      description: >-
        Errors raised before the endpoint runs: authentication, access, unknown
        path, server error.
      properties:
        message:
          type: string
        code:
          type: integer
        traceId:
          type: string
          description: Send this to support to find the request.
      required:
        - message
        - code
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: X-Api-Key
      description: Your API key, from your Tapfiliate account settings.

````

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