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

# Remove an invite recipient

> Removes a recipient from an invite, immediately invalidating their application link. The last remaining recipient on an invite cannot be removed. An invite can be amended as long as it hasn't been canceled, expired, or converted into an application.



## OpenAPI

````yaml /openapi/application-api.json delete /v1/invite-recipients/{id}
openapi: 3.1.0
info:
  description: >-
    Partner API for creating invites, tracking applications, and retrieving
    bonds.
  title: TheGuarantors Application API
  contact: {}
  version: '1.0'
servers:
  - url: https://api.theguarantors.com
security: []
paths:
  /v1/invite-recipients/{id}:
    delete:
      tags:
        - Invites
      summary: Remove an invite recipient
      description: >-
        Removes a recipient from an invite, immediately invalidating their
        application link. The last remaining recipient on an invite cannot be
        removed. An invite can be amended as long as it hasn't been canceled,
        expired, or converted into an application.
      parameters:
        - description: Invite Recipient ID
          name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '204':
          description: Recipient removed
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                message: Missing authorization header
                object: error
        '403':
          description: >-
            Forbidden


            | `error_code` | When |

            | --- | --- |

            | `invite_property_inactive` | The invite's own property is inactive
            |
          content:
            application/json:
              schema:
                type: object
                required:
                  - message
                  - object
                  - error_code
                properties:
                  error_code:
                    type: string
                    enum:
                      - invite_property_inactive
                  message:
                    type: string
                  object:
                    type: string
                    example: error
              example:
                message: cannot amend invite, property is inactive
                error_code: invite_property_inactive
                object: error
        '404':
          description: >-
            Not Found


            | `error_code` | When |

            | --- | --- |

            | `invite_recipient_not_found` | The invite recipient was not found
            |
          content:
            application/json:
              schema:
                type: object
                required:
                  - message
                  - object
                  - error_code
                properties:
                  error_code:
                    type: string
                    enum:
                      - invite_recipient_not_found
                  message:
                    type: string
                  object:
                    type: string
                    example: error
              example:
                message: recipient not found
                error_code: invite_recipient_not_found
                object: error
        '409':
          description: >-
            Conflict


            | `error_code` | When |

            | --- | --- |

            | `invite_accepted` | A recipient has already accepted the invite |

            | `invite_application_started` | The invite is in the process of
            being converted into an application |

            | `invite_canceled` | The invite has been canceled |

            | `invite_expired` | The invite has expired |
          content:
            application/json:
              schema:
                type: object
                required:
                  - message
                  - object
                  - error_code
                properties:
                  error_code:
                    type: string
                    enum:
                      - invite_accepted
                      - invite_application_started
                      - invite_canceled
                      - invite_expired
                  message:
                    type: string
                  object:
                    type: string
                    example: error
              example:
                message: cannot amend invite, a recipient has already accepted it
                error_code: invite_accepted
                object: error
        '422':
          description: >-
            Unprocessable Entity


            | `error_code` | When |

            | --- | --- |

            | `cannot_remove_last_recipient` | The recipient is the invite's
            last one |
          content:
            application/json:
              schema:
                type: object
                required:
                  - message
                  - object
                  - error_code
                properties:
                  error_code:
                    type: string
                    enum:
                      - cannot_remove_last_recipient
                  message:
                    type: string
                  object:
                    type: string
                    example: error
              example:
                message: >-
                  cannot remove invite recipient, invite must have at least one
                  recipient
                error_code: cannot_remove_last_recipient
                object: error
        '429':
          description: Rate limit exceeded
        '500':
          description: |-
            Internal Server Error

            | `error_code` | When |
            | --- | --- |
            | `internal_error` | An unexpected server error occurred |
          content:
            application/json:
              schema:
                type: object
                required:
                  - message
                  - object
                  - error_code
                properties:
                  error_code:
                    type: string
                    enum:
                      - internal_error
                  message:
                    type: string
                  object:
                    type: string
                    example: error
              example:
                message: unable to remove invite recipient
                error_code: internal_error
                object: error
      security:
        - BasicAuth: []
components:
  schemas:
    ErrorResponse:
      type: object
      required:
        - message
        - object
      properties:
        message:
          type: string
          example: invite not found
        object:
          type: string
          example: error
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic

````