HighLevel Redirect API

openapi: 3.2.0
info:
  title: Funnels Redirect API
  description: Documentation for funnels API
  version: '1.0'
  contact: {}
servers:
- url: https://services.leadconnectorhq.com
tags:
- name: Redirect
  description: Documentation for funnels API
paths:
  /funnels/lookup/redirect:
    post:
      operationId: create-redirect
      summary: Create Redirect
      description: The "Create Redirect" API Allows adding a new url redirect to the system. Use this endpoint to create a url redirect with the specified details. Ensure that the required information is provided in the request payload.
      parameters:
      - name: Version
        in: header
        description: API Version
        required: true
        schema:
          type: string
          enum:
          - '2021-07-28'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateRedirectParams'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateRedirectResponseDTO'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: ../common/common-schemas.json#/components/schemas/UnprocessableDTO
      tags:
      - Redirect
      security:
      - Location-Access:
        - funnels/redirect.write
  /funnels/lookup/redirect/{id}:
    patch:
      operationId: update-redirect-by-id
      summary: Update Redirect By Id
      description: The "Update Redirect By Id" API Allows updating an existing URL redirect in the system. Use this endpoint to modify a URL redirect with the specified ID using details provided in the request payload.
      parameters:
      - name: Version
        in: header
        description: API Version
        required: true
        schema:
          type: string
          enum:
          - '2021-07-28'
      - name: id
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateRedirectParams'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateRedirectResponseDTO'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: ../common/common-schemas.json#/components/schemas/UnprocessableDTO
      tags:
      - Redirect
      security:
      - Location-Access:
        - funnels/redirect.write
    delete:
      operationId: delete-redirect-by-id
      summary: Delete Redirect By Id
      description: The "Delete Redirect By Id" API Allows deletion of a URL redirect from the system using its unique identifier. Use this endpoint to delete a URL redirect with the specified ID using details provided in the request payload.
      parameters:
      - name: Version
        in: header
        description: API Version
        required: true
        schema:
          type: string
          enum:
          - '2021-07-28'
      - name: id
        required: true
        in: path
        schema:
          type: string
      - name: locationId
        required: true
        in: query
        example: 6p2RxpgtMKQwO3E6IUaT
        schema:
          type: string
      responses:
        '200':
          description: Successful response - URL redirect deleted successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteRedirectResponseDTO'
        '422':
          description: Unprocessable Entity - The provided data is invalid or incomplete
      tags:
      - Redirect
      security:
      - Location-Access:
        - funnels/redirect.write
  /funnels/lookup/redirect/list:
    get:
      operationId: fetch-redirects-list
      summary: Fetch List of Redirects
      description: Retrieves a list of all URL redirects based on the given query parameters.
      parameters:
      - name: Version
        in: header
        description: API Version
        required: true
        schema:
          type: string
          enum:
          - '2021-07-28'
      - name: locationId
        required: true
        in: query
        example: 6p2RxpgtMKQwO3E6IUaT
        schema:
          type: string
      - name: limit
        required: true
        in: query
        example: 20
        schema:
          type: number
      - name: offset
        required: true
        in: query
        example: 10
        schema:
          type: number
      - name: search
        required: false
        in: query
        example: example.com/test
        schema:
          type: string
      responses:
        '200':
          description: Successful response - List of URL redirects returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RedirectListResponseDTO'
        '422':
          description: Unprocessable Entity - The provided data is invalid or incomplete
      tags:
      - Redirect
      security:
      - Location-Access:
        - funnels/redirect.readonly
components:
  schemas:
    RedirectResponseDTO:
      type: object
      properties:
        id:
          type: string
          example: 6p2RxpgtMKQwO3E6IUaT
          description: Unique identifier of the redirect
        locationId:
          type: string
          example: 6p2RxpgtMKQwO3E6IUaT
          description: Identifier of the location associated with the redirect
        domain:
          type: string
          example: www.example.com
          description: Domain where the redirect occurs
        path:
          type: string
          example: /old-path
          description: Original path that will be redirected
        pathLowercase:
          type: string
          example: /old-path
          description: Lowercase version of the original path
        type:
          type: string
          example: Permanent
          description: Type of redirect (e.g., Permanent, Temporary)
        target:
          type: string
          example: https://www.example.com/new-path
          description: Target URL to which the original path will be redirected
        action:
          type: string
          example: url
          description: Action performed by the redirect
      required:
      - id
      - locationId
      - domain
      - path
      - pathLowercase
      - type
      - target
      - action
    UpdateRedirectResponseDTO:
      type: object
      properties:
        data:
          description: Data containing details of the updated redirect
          allOf:
          - $ref: '#/components/schemas/RedirectResponseDTO'
      required:
      - data
    RedirectListResponseDTO:
      type: object
      properties:
        data:
          type: object
          example:
            count: 42
            data: []
          description: Object containing the count of redirects and an array of redirect data
      required:
      - data
    UpdateRedirectParams:
      type: object
      properties:
        target:
          type: string
          example: https://www.google.com
        action:
          type: string
          example: URL
          enum:
          - funnel
          - website
          - url
          - all
        locationId:
          type: string
          example: 6p2RxpgtMKQwO3E6IUaT
      required:
      - target
      - action
      - locationId
    CreateRedirectResponseDTO:
      type: object
      properties:
        data:
          description: Data containing details of the created redirect
          allOf:
          - $ref: '#/components/schemas/RedirectResponseDTO'
      required:
      - data
    CreateRedirectParams:
      type: object
      properties:
        locationId:
          type: string
          example: 6p2RxpgtMKQwO3E6IUaT
        domain:
          type: string
          example: example.com
        path:
          type: string
          example: /Hello
        target:
          type: string
          example: https://www.google.com
        action:
          type: string
          example: URL
          enum:
          - funnel
          - website
          - url
          - all
      required:
      - locationId
      - domain
      - path
      - target
      - action
    DeleteRedirectResponseDTO:
      type: object
      properties:
        data:
          type: object
          example:
            status: ok
          description: Status of the delete operation
      required:
      - data
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      name: Authorization
      in: header
      description: Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.
      type: http
    Location-Access:
      scheme: bearer
      bearerFormat: JWT
      name: Authorization
      in: header
      description: Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.
      type: http
    Agency-Access:
      scheme: bearer
      bearerFormat: JWT
      name: Authorization
      in: header
      description: Use the Access Token generated with user type as Agency (OR) Private Integration Token of Agency.
      type: http
x-tagGroups:
  name: Funnels
  tags:
  - Funnel
  - Products
  - Prices
  - Integrations
  - Redirect