openapi: 3.0.3
info:
  title: '301.pro API Documentation'
  description: ''
  version: 1.0.0
servers:
  -
    url: 'https://api.301.pro'
paths:
  /v1/teams:
    get:
      summary: 'Retrieve a list of teams available for the authenticated token.'
      operationId: retrieveAListOfTeamsAvailableForTheAuthenticatedToken
      description: ''
      parameters:
        -
          in: query
          name: 'filter[id]'
          description: 'UUID of the Team.'
          example: 000de240-04fe-40dd-8928-a94f61040035
          required: false
          schema:
            type: string
            description: 'UUID of the Team.'
            example: 000de240-04fe-40dd-8928-a94f61040035
            nullable: false
        -
          in: query
          name: 'filter[name]'
          description: 'Name of the Team. Partial Search. Wildcards are not needed.'
          example: null
          required: false
          schema:
            type: string
            description: 'Name of the Team. Partial Search. Wildcards are not needed.'
            example: null
            nullable: false
        -
          in: query
          name: 'filter[teamType]'
          description: 'Team Subscription Plan.'
          example: null
          required: false
          schema:
            type: string
            description: 'Team Subscription Plan.'
            example: null
            nullable: false
            enum:
              - business_demo
              - artist
              - professional
              - business
              - realtime
        -
          in: query
          name: 'filter[createdBy]'
          description: 'ID of the user that created the Team.'
          example: null
          required: false
          schema:
            type: string
            description: 'ID of the user that created the Team.'
            example: null
            nullable: false
        -
          in: query
          name: 'filter[createdAt]'
          description: 'Date of creation. You can filter for a specific date or before/after a certain date by prefixing with > or <.'
          example: '>2025-01-01'
          required: false
          schema:
            type: string
            description: 'Date of creation. You can filter for a specific date or before/after a certain date by prefixing with > or <.'
            example: '>2025-01-01'
            nullable: false
        -
          in: query
          name: 'filter[updatedAt]'
          description: 'Date of last update. You can filter for a specific date or before/after a certain date by prefixing with > or <.'
          example: '<2025-04-01'
          required: false
          schema:
            type: string
            description: 'Date of last update. You can filter for a specific date or before/after a certain date by prefixing with > or <.'
            example: '<2025-04-01'
            nullable: false
        -
          in: query
          name: include
          description: 'Comma separated list of relationships to include - Allowed relationships include domains, campaigns, pixels and labels.'
          example: 'domains,labels'
          required: false
          schema:
            type: string
            description: 'Comma separated list of relationships to include - Allowed relationships include domains, campaigns, pixels and labels.'
            example: 'domains,labels'
            nullable: false
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      id: 000de240-04fe-40dd-8928-a94f61040035
                      teamOwnerId: 000de240-355e-4814-8606-d308260927ae
                      name: 'Business Demo'
                      teamType: business_demo
                      status: published
                      createdAt: '2025-09-29T18:34:50.000000Z'
                      updatedAt: '2025-09-29T18:35:25.000000Z'
                    -
                      id: 000de240-e3d4-464e-9f7a-b160235a1f05
                      teamOwnerId: 000de240-355e-4814-8606-d308260927ae
                      name: Artist
                      teamType: artist
                      status: published
                      createdAt: '2025-09-29T18:34:45.000000Z'
                      updatedAt: '2025-09-29T18:35:21.000000Z'
                    -
                      id: 000de240-e4b3-4177-946f-c78813737cb3
                      teamOwnerId: 000de240-355e-4814-8606-d308260927ae
                      name: Professional
                      teamType: professional
                      status: published
                      createdAt: '2025-09-29T18:34:41.000000Z'
                      updatedAt: '2025-09-29T18:35:16.000000Z'
                    -
                      id: 000de240-990b-4a6b-be68-b0c178b11949
                      teamOwnerId: 000de240-355e-4814-8606-d308260927ae
                      name: Business
                      teamType: business
                      status: published
                      createdAt: '2025-09-29T18:34:36.000000Z'
                      updatedAt: '2025-09-29T18:35:11.000000Z'
                    -
                      id: 000de240-2e36-4621-a3fb-782db631e683
                      teamOwnerId: 000de240-355e-4814-8606-d308260927ae
                      name: Realtime
                      teamType: realtime
                      status: published
                      createdAt: '2025-09-29T18:34:31.000000Z'
                      updatedAt: '2025-09-29T18:35:06.000000Z'
                    -
                      id: 9ffee0a0-99cf-48e6-9abb-1050d01e3493
                      teamOwnerId: 000de240-355e-4814-8606-d308260927ae
                      name: "Scribe's Team"
                      teamType: business_demo
                      status: published
                      createdAt: '2025-09-29T18:26:31.000000Z'
                      updatedAt: '2025-09-29T18:26:35.000000Z'
                    -
                      id: 9ffedf1c-dbbe-4044-9632-877c56811cff
                      teamOwnerId: 000de240-355e-4814-8606-d308260927ae
                      name: "Scribe's Team"
                      teamType: business_demo
                      status: published
                      createdAt: '2025-09-29T18:22:17.000000Z'
                      updatedAt: '2025-09-29T18:22:22.000000Z'
                    -
                      id: 9ffedd8d-eb0f-49d3-b7b3-9362241fb0aa
                      teamOwnerId: 000de240-355e-4814-8606-d308260927ae
                      name: "Scribe's Team"
                      teamType: business_demo
                      status: published
                      createdAt: '2025-09-29T18:17:55.000000Z'
                      updatedAt: '2025-09-29T18:17:59.000000Z'
                    -
                      id: 9ffedd53-b9c9-4bb5-a150-7097338974e4
                      teamOwnerId: 000de240-355e-4814-8606-d308260927ae
                      name: "Scribe's Team"
                      teamType: business_demo
                      status: published
                      createdAt: '2025-09-29T18:17:17.000000Z'
                      updatedAt: '2025-09-29T18:17:21.000000Z'
                  links:
                    first: 'https://api.301.pro/v1/teams?page=1'
                    last: 'https://api.301.pro/v1/teams?page=1'
                    prev: null
                    next: null
                  meta:
                    current_page: 1
                    from: 1
                    last_page: 1
                    links:
                      -
                        url: null
                        label: '&laquo; Previous'
                        active: false
                      -
                        url: 'https://api.301.pro/v1/teams?page=1'
                        label: '1'
                        active: true
                      -
                        url: null
                        label: 'Next &raquo;'
                        active: false
                    path: 'https://api.301.pro/v1/teams'
                    per_page: 15
                    to: 9
                    total: 9
                properties:
                  data:
                    type: array
                    example:
                      -
                        id: 000de240-04fe-40dd-8928-a94f61040035
                        teamOwnerId: 000de240-355e-4814-8606-d308260927ae
                        name: 'Business Demo'
                        teamType: business_demo
                        status: published
                        createdAt: '2025-09-29T18:34:50.000000Z'
                        updatedAt: '2025-09-29T18:35:25.000000Z'
                      -
                        id: 000de240-e3d4-464e-9f7a-b160235a1f05
                        teamOwnerId: 000de240-355e-4814-8606-d308260927ae
                        name: Artist
                        teamType: artist
                        status: published
                        createdAt: '2025-09-29T18:34:45.000000Z'
                        updatedAt: '2025-09-29T18:35:21.000000Z'
                      -
                        id: 000de240-e4b3-4177-946f-c78813737cb3
                        teamOwnerId: 000de240-355e-4814-8606-d308260927ae
                        name: Professional
                        teamType: professional
                        status: published
                        createdAt: '2025-09-29T18:34:41.000000Z'
                        updatedAt: '2025-09-29T18:35:16.000000Z'
                      -
                        id: 000de240-990b-4a6b-be68-b0c178b11949
                        teamOwnerId: 000de240-355e-4814-8606-d308260927ae
                        name: Business
                        teamType: business
                        status: published
                        createdAt: '2025-09-29T18:34:36.000000Z'
                        updatedAt: '2025-09-29T18:35:11.000000Z'
                      -
                        id: 000de240-2e36-4621-a3fb-782db631e683
                        teamOwnerId: 000de240-355e-4814-8606-d308260927ae
                        name: Realtime
                        teamType: realtime
                        status: published
                        createdAt: '2025-09-29T18:34:31.000000Z'
                        updatedAt: '2025-09-29T18:35:06.000000Z'
                      -
                        id: 9ffee0a0-99cf-48e6-9abb-1050d01e3493
                        teamOwnerId: 000de240-355e-4814-8606-d308260927ae
                        name: "Scribe's Team"
                        teamType: business_demo
                        status: published
                        createdAt: '2025-09-29T18:26:31.000000Z'
                        updatedAt: '2025-09-29T18:26:35.000000Z'
                      -
                        id: 9ffedf1c-dbbe-4044-9632-877c56811cff
                        teamOwnerId: 000de240-355e-4814-8606-d308260927ae
                        name: "Scribe's Team"
                        teamType: business_demo
                        status: published
                        createdAt: '2025-09-29T18:22:17.000000Z'
                        updatedAt: '2025-09-29T18:22:22.000000Z'
                      -
                        id: 9ffedd8d-eb0f-49d3-b7b3-9362241fb0aa
                        teamOwnerId: 000de240-355e-4814-8606-d308260927ae
                        name: "Scribe's Team"
                        teamType: business_demo
                        status: published
                        createdAt: '2025-09-29T18:17:55.000000Z'
                        updatedAt: '2025-09-29T18:17:59.000000Z'
                      -
                        id: 9ffedd53-b9c9-4bb5-a150-7097338974e4
                        teamOwnerId: 000de240-355e-4814-8606-d308260927ae
                        name: "Scribe's Team"
                        teamType: business_demo
                        status: published
                        createdAt: '2025-09-29T18:17:17.000000Z'
                        updatedAt: '2025-09-29T18:17:21.000000Z'
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: 000de240-04fe-40dd-8928-a94f61040035
                        teamOwnerId:
                          type: string
                          example: 000de240-355e-4814-8606-d308260927ae
                        name:
                          type: string
                          example: 'Business Demo'
                        teamType:
                          type: string
                          example: business_demo
                        status:
                          type: string
                          example: published
                        createdAt:
                          type: string
                          example: '2025-09-29T18:34:50.000000Z'
                        updatedAt:
                          type: string
                          example: '2025-09-29T18:35:25.000000Z'
                  links:
                    type: object
                    properties:
                      first:
                        type: string
                        example: 'https://api.301.pro/v1/teams?page=1'
                      last:
                        type: string
                        example: 'https://api.301.pro/v1/teams?page=1'
                      prev:
                        type: string
                        example: null
                      next:
                        type: string
                        example: null
                  meta:
                    type: object
                    properties:
                      current_page:
                        type: integer
                        example: 1
                      from:
                        type: integer
                        example: 1
                      last_page:
                        type: integer
                        example: 1
                      links:
                        type: array
                        example:
                          -
                            url: null
                            label: '&laquo; Previous'
                            active: false
                          -
                            url: 'https://api.301.pro/v1/teams?page=1'
                            label: '1'
                            active: true
                          -
                            url: null
                            label: 'Next &raquo;'
                            active: false
                        items:
                          type: object
                          properties:
                            url:
                              type: string
                              example: null
                            label:
                              type: string
                              example: '&laquo; Previous'
                            active:
                              type: boolean
                              example: false
                      path:
                        type: string
                        example: 'https://api.301.pro/v1/teams'
                      per_page:
                        type: integer
                        example: 15
                      to:
                        type: integer
                        example: 9
                      total:
                        type: integer
                        example: 9
      tags:
        - Teams
  '/v1/team/{team_id}/labels':
    get:
      summary: 'Retrieve a list of Team Labels'
      operationId: retrieveAListOfTeamLabels
      description: 'Team Labels are used to categorize ProLinks and Campaigns.'
      parameters:
        -
          in: query
          name: 'filter[title]'
          description: 'Label Title.  Will return any Labels where Title contains the provided value. Wildcards are not needed.'
          example: '"Email"'
          required: false
          schema:
            type: string
            description: 'Label Title.  Will return any Labels where Title contains the provided value. Wildcards are not needed.'
            example: '"Email"'
            nullable: false
        -
          in: query
          name: 'filter[color]'
          description: 'Label Color.  Will return any Labels that include the provided color. Wildcards are not needed.'
          example: '"#00eeff"'
          required: false
          schema:
            type: string
            description: 'Label Color.  Will return any Labels that include the provided color. Wildcards are not needed.'
            example: '"#00eeff"'
            nullable: false
        -
          in: query
          name: 'filter[description]'
          description: 'Label Description.  Will return any Labels that where Description contains the provided value. Wildcards are not needed.'
          example: '"email"'
          required: false
          schema:
            type: string
            description: 'Label Description.  Will return any Labels that where Description contains the provided value. Wildcards are not needed.'
            example: '"email"'
            nullable: false
        -
          in: query
          name: 'filter[createdBy]'
          description: 'ID of the user that created the Label.'
          example: null
          required: false
          schema:
            type: string
            description: 'ID of the user that created the Label.'
            example: null
            nullable: false
        -
          in: query
          name: 'filter[updatedBy]'
          description: 'ID of the use that last updated the Label.'
          example: null
          required: false
          schema:
            type: string
            description: 'ID of the use that last updated the Label.'
            example: null
            nullable: false
        -
          in: query
          name: 'filter[createdAt]'
          description: 'Date the Label was created. You can filter for a specific date or before/after a certain date by prefixing with > or <.'
          example: '>2025-01-01'
          required: false
          schema:
            type: string
            description: 'Date the Label was created. You can filter for a specific date or before/after a certain date by prefixing with > or <.'
            example: '>2025-01-01'
            nullable: false
        -
          in: query
          name: 'filter[updatedAt]'
          description: 'Date the Label was updated. You can filter for a specific date or before/after a certain date by prefixing with > or <.'
          example: '>2025-01-01'
          required: false
          schema:
            type: string
            description: 'Date the Label was updated. You can filter for a specific date or before/after a certain date by prefixing with > or <.'
            example: '>2025-01-01'
            nullable: false
        -
          in: query
          name: sort
          description: 'Will Sort the results by title, color, createdAt, or updatedAt. Comma seperated. Prefix with - to sort descending.'
          example: '-createdAt,title'
          required: false
          schema:
            type: string
            description: 'Will Sort the results by title, color, createdAt, or updatedAt. Comma seperated. Prefix with - to sort descending.'
            example: '-createdAt,title'
            nullable: false
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      id: 000de240-327b-4696-9ce6-1ce91a4f2acb
                      title: Email
                      color: null
                      description: '0'
                      createdAt: '2025-09-29T18:34:53.000000Z'
                      updatedAt: '2025-09-29T18:34:53.000000Z'
                    -
                      id: 000de240-d496-4d83-a42b-2eae485eeff9
                      title: Social
                      color: null
                      description: '1'
                      createdAt: '2025-09-29T18:34:53.000000Z'
                      updatedAt: '2025-09-29T18:34:53.000000Z'
                    -
                      id: 000de240-439e-4664-ad11-76d83bccd90e
                      title: Announcement
                      color: null
                      description: '2'
                      createdAt: '2025-09-29T18:34:53.000000Z'
                      updatedAt: '2025-09-29T18:34:53.000000Z'
                    -
                      id: 000de240-3a27-4fd2-9e9c-0d6bbbe9d906
                      title: Documentation
                      color: null
                      description: '3'
                      createdAt: '2025-09-29T18:34:53.000000Z'
                      updatedAt: '2025-09-29T18:34:53.000000Z'
                    -
                      id: 000de240-7c52-41d9-b9c5-dcbadcae9e93
                      title: Demo
                      color: null
                      description: '4'
                      createdAt: '2025-09-29T18:34:53.000000Z'
                      updatedAt: '2025-09-29T18:34:53.000000Z'
                    -
                      id: 000de240-d5c2-4212-9703-c5459bbea393
                      title: Event
                      color: null
                      description: '5'
                      createdAt: '2025-09-29T18:34:53.000000Z'
                      updatedAt: '2025-09-29T18:34:53.000000Z'
                    -
                      id: 000de240-4f14-4be8-b243-26a78f218bb4
                      title: Affiliate
                      color: null
                      description: 'Affiliate Marketing'
                      createdAt: '2025-09-29T18:34:53.000000Z'
                      updatedAt: '2025-09-29T18:34:53.000000Z'
                  links:
                    first: 'https://api.301.pro/v1/team/000de240-2e36-4621-a3fb-782db631e683/labels?page=1'
                    last: 'https://api.301.pro/v1/team/000de240-2e36-4621-a3fb-782db631e683/labels?page=1'
                    prev: null
                    next: null
                  meta:
                    current_page: 1
                    from: 1
                    last_page: 1
                    links:
                      -
                        url: null
                        label: '&laquo; Previous'
                        active: false
                      -
                        url: 'https://api.301.pro/v1/team/000de240-2e36-4621-a3fb-782db631e683/labels?page=1'
                        label: '1'
                        active: true
                      -
                        url: null
                        label: 'Next &raquo;'
                        active: false
                    path: 'https://api.301.pro/v1/team/000de240-2e36-4621-a3fb-782db631e683/labels'
                    per_page: 30
                    to: 7
                    total: 7
                properties:
                  data:
                    type: array
                    example:
                      -
                        id: 000de240-327b-4696-9ce6-1ce91a4f2acb
                        title: Email
                        color: null
                        description: '0'
                        createdAt: '2025-09-29T18:34:53.000000Z'
                        updatedAt: '2025-09-29T18:34:53.000000Z'
                      -
                        id: 000de240-d496-4d83-a42b-2eae485eeff9
                        title: Social
                        color: null
                        description: '1'
                        createdAt: '2025-09-29T18:34:53.000000Z'
                        updatedAt: '2025-09-29T18:34:53.000000Z'
                      -
                        id: 000de240-439e-4664-ad11-76d83bccd90e
                        title: Announcement
                        color: null
                        description: '2'
                        createdAt: '2025-09-29T18:34:53.000000Z'
                        updatedAt: '2025-09-29T18:34:53.000000Z'
                      -
                        id: 000de240-3a27-4fd2-9e9c-0d6bbbe9d906
                        title: Documentation
                        color: null
                        description: '3'
                        createdAt: '2025-09-29T18:34:53.000000Z'
                        updatedAt: '2025-09-29T18:34:53.000000Z'
                      -
                        id: 000de240-7c52-41d9-b9c5-dcbadcae9e93
                        title: Demo
                        color: null
                        description: '4'
                        createdAt: '2025-09-29T18:34:53.000000Z'
                        updatedAt: '2025-09-29T18:34:53.000000Z'
                      -
                        id: 000de240-d5c2-4212-9703-c5459bbea393
                        title: Event
                        color: null
                        description: '5'
                        createdAt: '2025-09-29T18:34:53.000000Z'
                        updatedAt: '2025-09-29T18:34:53.000000Z'
                      -
                        id: 000de240-4f14-4be8-b243-26a78f218bb4
                        title: Affiliate
                        color: null
                        description: 'Affiliate Marketing'
                        createdAt: '2025-09-29T18:34:53.000000Z'
                        updatedAt: '2025-09-29T18:34:53.000000Z'
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: 000de240-327b-4696-9ce6-1ce91a4f2acb
                        title:
                          type: string
                          example: Email
                        color:
                          type: string
                          example: null
                        description:
                          type: string
                          example: '0'
                        createdAt:
                          type: string
                          example: '2025-09-29T18:34:53.000000Z'
                        updatedAt:
                          type: string
                          example: '2025-09-29T18:34:53.000000Z'
                  links:
                    type: object
                    properties:
                      first:
                        type: string
                        example: 'https://api.301.pro/v1/team/000de240-2e36-4621-a3fb-782db631e683/labels?page=1'
                      last:
                        type: string
                        example: 'https://api.301.pro/v1/team/000de240-2e36-4621-a3fb-782db631e683/labels?page=1'
                      prev:
                        type: string
                        example: null
                      next:
                        type: string
                        example: null
                  meta:
                    type: object
                    properties:
                      current_page:
                        type: integer
                        example: 1
                      from:
                        type: integer
                        example: 1
                      last_page:
                        type: integer
                        example: 1
                      links:
                        type: array
                        example:
                          -
                            url: null
                            label: '&laquo; Previous'
                            active: false
                          -
                            url: 'https://api.301.pro/v1/team/000de240-2e36-4621-a3fb-782db631e683/labels?page=1'
                            label: '1'
                            active: true
                          -
                            url: null
                            label: 'Next &raquo;'
                            active: false
                        items:
                          type: object
                          properties:
                            url:
                              type: string
                              example: null
                            label:
                              type: string
                              example: '&laquo; Previous'
                            active:
                              type: boolean
                              example: false
                      path:
                        type: string
                        example: 'https://api.301.pro/v1/team/000de240-2e36-4621-a3fb-782db631e683/labels'
                      per_page:
                        type: integer
                        example: 30
                      to:
                        type: integer
                        example: 7
                      total:
                        type: integer
                        example: 7
      tags:
        - Team
    post:
      summary: 'Create a Team Label'
      operationId: createATeamLabel
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                oneOf:
                  -
                    description: ''
                    type: object
                    example:
                      id: 000de240-327b-4696-9ce6-1ce91a4f2acb
                      title: Email
                      color: null
                      description: '0'
                      createdAt: '2025-09-29T18:34:53.000000Z'
                      updatedAt: '2025-09-29T18:34:53.000000Z'
                    properties:
                      id:
                        type: string
                        example: 000de240-327b-4696-9ce6-1ce91a4f2acb
                      title:
                        type: string
                        example: Email
                      color:
                        type: string
                        example: null
                      description:
                        type: string
                        example: '0'
                      createdAt:
                        type: string
                        example: '2025-09-29T18:34:53.000000Z'
                      updatedAt:
                        type: string
                        example: '2025-09-29T18:34:53.000000Z'
                  -
                    description: ''
                    type: object
                    example:
                      status: error
                      message: 'Access Denied'
                    properties:
                      status:
                        type: string
                        example: error
                      message:
                        type: string
                        example: 'Access Denied'
      tags:
        - Team
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                title:
                  type: string
                  description: 'The title of the Label.'
                  example: Documentation
                  nullable: false
                color:
                  type: string
                  description: 'The color of the Label.'
                  example: '#fbf323'
                  nullable: false
                description:
                  type: string
                  description: 'The description of the Label.'
                  example: null
                  nullable: false
              required:
                - title
    parameters:
      -
        in: path
        name: team_id
        description: 'The ID of the team.'
        example: 9ffef0a7-e8a8-4d1b-98d1-fb819a02ded0
        required: true
        schema:
          type: string
  '/v1/team/{team_id}/labels/{id}':
    get:
      summary: 'Retrieve a Team Label'
      operationId: retrieveATeamLabel
      description: ''
      parameters:
        -
          in: query
          name: include
          description: 'Retrieve relationships.  Allowed relationships: assignments - include label assignment relationships.'
          example: include=assignments
          required: false
          schema:
            type: string
            description: 'Retrieve relationships.  Allowed relationships: assignments - include label assignment relationships.'
            example: include=assignments
            nullable: false
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                oneOf:
                  -
                    description: ''
                    type: object
                    example:
                      id: 000de240-327b-4696-9ce6-1ce91a4f2acb
                      title: Email
                      color: null
                      description: '0'
                      createdAt: '2025-09-29T18:34:53.000000Z'
                      updatedAt: '2025-09-29T18:34:53.000000Z'
                    properties:
                      id:
                        type: string
                        example: 000de240-327b-4696-9ce6-1ce91a4f2acb
                      title:
                        type: string
                        example: Email
                      color:
                        type: string
                        example: null
                      description:
                        type: string
                        example: '0'
                      createdAt:
                        type: string
                        example: '2025-09-29T18:34:53.000000Z'
                      updatedAt:
                        type: string
                        example: '2025-09-29T18:34:53.000000Z'
                  -
                    description: ''
                    type: object
                    example:
                      status: error
                      message: 'Access Denied'
                    properties:
                      status:
                        type: string
                        example: error
                      message:
                        type: string
                        example: 'Access Denied'
      tags:
        - Team
    put:
      summary: 'Update a Team Label'
      operationId: updateATeamLabel
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                oneOf:
                  -
                    description: ''
                    type: object
                    example:
                      id: 000de240-327b-4696-9ce6-1ce91a4f2acb
                      title: Email
                      color: null
                      description: '0'
                      createdAt: '2025-09-29T18:34:53.000000Z'
                      updatedAt: '2025-09-29T18:34:53.000000Z'
                    properties:
                      id:
                        type: string
                        example: 000de240-327b-4696-9ce6-1ce91a4f2acb
                      title:
                        type: string
                        example: Email
                      color:
                        type: string
                        example: null
                      description:
                        type: string
                        example: '0'
                      createdAt:
                        type: string
                        example: '2025-09-29T18:34:53.000000Z'
                      updatedAt:
                        type: string
                        example: '2025-09-29T18:34:53.000000Z'
                  -
                    description: ''
                    type: object
                    example:
                      status: error
                      message: 'Access Denied'
                    properties:
                      status:
                        type: string
                        example: error
                      message:
                        type: string
                        example: 'Access Denied'
      tags:
        - Team
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                title:
                  type: string
                  description: 'The title of the Label.'
                  example: Documentation
                  nullable: false
                color:
                  type: string
                  description: 'The color of the Label.'
                  example: '#fbf323'
                  nullable: false
                description:
                  type: string
                  description: 'The description of the Label.'
                  example: null
                  nullable: false
              required:
                - title
    delete:
      summary: 'Delete a Team Label'
      operationId: deleteATeamLabel
      description: 'Deletes a team label and optionally all label assignments'
      parameters:
        -
          in: query
          name: force
          description: 'must equal "true" exactly to Remove label and all of its assignments (force=true).'
          example: 'true'
          required: false
          schema:
            type: string
            description: 'must equal "true" exactly to Remove label and all of its assignments (force=true).'
            example: 'true'
            nullable: false
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  status: success
                properties:
                  status:
                    type: string
                    example: success
      tags:
        - Team
    parameters:
      -
        in: path
        name: team_id
        description: 'The ID of the team.'
        example: e5ab8065-3013-433a-84a4-e81a5ca6c949
        required: true
        schema:
          type: string
      -
        in: path
        name: id
        description: 'The ID of the Label.'
        example: c6ab8065-3013-433a-84a4-e81a5ca6c949
        required: true
        schema:
          type: string
  '/v1/team/{team_id}/pixels':
    get:
      summary: 'Retrieve a list of Team Pixel '
      operationId: retrieveAListOfTeamPixel
      description: ''
      parameters:
        -
          in: query
          name: 'filter[pixelType]'
          description: 'Pixel Type'
          example: FacebookPixel
          required: false
          schema:
            type: string
            description: 'Pixel Type'
            example: FacebookPixel
            nullable: false
        -
          in: query
          name: 'filter[pixelTrackingId]'
          description: 'Pixel Tracking Id'
          example: null
          required: false
          schema:
            type: string
            description: 'Pixel Tracking Id'
            example: null
            nullable: false
        -
          in: query
          name: 'filter[createdBy]'
          description: 'ID of the user that created the Team Pixel.'
          example: null
          required: false
          schema:
            type: string
            description: 'ID of the user that created the Team Pixel.'
            example: null
            nullable: false
        -
          in: query
          name: 'filter[updatedBy]'
          description: 'ID of the user that recently the Team Pixel.'
          example: null
          required: false
          schema:
            type: string
            description: 'ID of the user that recently the Team Pixel.'
            example: null
            nullable: false
        -
          in: query
          name: 'filter[createdAt]'
          description: 'Filter by date of creation Team Pixel. You can filter for a specific date or before/after a certain date by prefixing with > or <'
          example: '>2025-01-01'
          required: false
          schema:
            type: string
            description: 'Filter by date of creation Team Pixel. You can filter for a specific date or before/after a certain date by prefixing with > or <'
            example: '>2025-01-01'
            nullable: false
        -
          in: query
          name: 'filter[updatedAt]'
          description: 'Filter by last updated date Team Pixel. You can filter for a specific date or before/after a certain date by prefixing with > or <'
          example: '<2025-06-01'
          required: false
          schema:
            type: string
            description: 'Filter by last updated date Team Pixel. You can filter for a specific date or before/after a certain date by prefixing with > or <'
            example: '<2025-06-01'
            nullable: false
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      id: 9e5c7b08-b278-4450-9bb3-2f4537518919
                      subjectType: team
                      subjectId: 9e522e02-f1c7-4c1e-ba56-bafdfa930a69
                      pixelType: FacebookPixel
                      pixelTypeDisplay: 'Facebook Pixel'
                      pixelTrackingId: '5884321354687987'
                      description: 'Team Facebook Pixel'
                      createdAt: '2025-03-05T18:46:23.000000Z'
                      updatedAt: '2025-03-05T18:46:23.000000Z'
                      createdBy: 9e522e02-f0fb-494f-976b-c10ccb498a8b
                      updatedBy: 9e522e02-f0fb-494f-976b-c10ccb498a8b
                  links:
                    first: 'https://api.301.pro/v1/team/9e522e02-f1c7-4c1e-ba56-bafdfa930a69/pixels?page=1'
                    last: 'https://api.301.pro/v1/team/9e522e02-f1c7-4c1e-ba56-bafdfa930a69/pixels?page=1'
                    prev: null
                    next: null
                  meta:
                    current_page: 1
                    from: 1
                    last_page: 1
                    links:
                      -
                        url: null
                        label: '&laquo; Previous'
                        active: false
                      -
                        url: 'https://api.301.pro/v1/team/9e522e02-f1c7-4c1e-ba56-bafdfa930a69/pixels?page=1'
                        label: '1'
                        active: true
                      -
                        url: null
                        label: 'Next &raquo;'
                        active: false
                    path: 'https://api.301.pro/v1/team/9e522e02-f1c7-4c1e-ba56-bafdfa930a69/pixels'
                    per_page: 15
                    to: 1
                    total: 1
                properties:
                  data:
                    type: array
                    example:
                      -
                        id: 9e5c7b08-b278-4450-9bb3-2f4537518919
                        subjectType: team
                        subjectId: 9e522e02-f1c7-4c1e-ba56-bafdfa930a69
                        pixelType: FacebookPixel
                        pixelTypeDisplay: 'Facebook Pixel'
                        pixelTrackingId: '5884321354687987'
                        description: 'Team Facebook Pixel'
                        createdAt: '2025-03-05T18:46:23.000000Z'
                        updatedAt: '2025-03-05T18:46:23.000000Z'
                        createdBy: 9e522e02-f0fb-494f-976b-c10ccb498a8b
                        updatedBy: 9e522e02-f0fb-494f-976b-c10ccb498a8b
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: 9e5c7b08-b278-4450-9bb3-2f4537518919
                        subjectType:
                          type: string
                          example: team
                        subjectId:
                          type: string
                          example: 9e522e02-f1c7-4c1e-ba56-bafdfa930a69
                        pixelType:
                          type: string
                          example: FacebookPixel
                        pixelTypeDisplay:
                          type: string
                          example: 'Facebook Pixel'
                        pixelTrackingId:
                          type: string
                          example: '5884321354687987'
                        description:
                          type: string
                          example: 'Team Facebook Pixel'
                        createdAt:
                          type: string
                          example: '2025-03-05T18:46:23.000000Z'
                        updatedAt:
                          type: string
                          example: '2025-03-05T18:46:23.000000Z'
                        createdBy:
                          type: string
                          example: 9e522e02-f0fb-494f-976b-c10ccb498a8b
                        updatedBy:
                          type: string
                          example: 9e522e02-f0fb-494f-976b-c10ccb498a8b
                  links:
                    type: object
                    properties:
                      first:
                        type: string
                        example: 'https://api.301.pro/v1/team/9e522e02-f1c7-4c1e-ba56-bafdfa930a69/pixels?page=1'
                      last:
                        type: string
                        example: 'https://api.301.pro/v1/team/9e522e02-f1c7-4c1e-ba56-bafdfa930a69/pixels?page=1'
                      prev:
                        type: string
                        example: null
                      next:
                        type: string
                        example: null
                  meta:
                    type: object
                    properties:
                      current_page:
                        type: integer
                        example: 1
                      from:
                        type: integer
                        example: 1
                      last_page:
                        type: integer
                        example: 1
                      links:
                        type: array
                        example:
                          -
                            url: null
                            label: '&laquo; Previous'
                            active: false
                          -
                            url: 'https://api.301.pro/v1/team/9e522e02-f1c7-4c1e-ba56-bafdfa930a69/pixels?page=1'
                            label: '1'
                            active: true
                          -
                            url: null
                            label: 'Next &raquo;'
                            active: false
                        items:
                          type: object
                          properties:
                            url:
                              type: string
                              example: null
                            label:
                              type: string
                              example: '&laquo; Previous'
                            active:
                              type: boolean
                              example: false
                      path:
                        type: string
                        example: 'https://api.301.pro/v1/team/9e522e02-f1c7-4c1e-ba56-bafdfa930a69/pixels'
                      per_page:
                        type: integer
                        example: 15
                      to:
                        type: integer
                        example: 1
                      total:
                        type: integer
                        example: 1
      tags:
        - Team
    post:
      summary: 'Create Team Pixel '
      operationId: createTeamPixel
      description: 'Create a new Team Pixel.'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  status: error
                  message: 'Access Denied'
                properties:
                  status:
                    type: string
                    example: error
                  message:
                    type: string
                    example: 'Access Denied'
      tags:
        - Team
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                pixelType:
                  type: string
                  description: 'The Type Of Pixel'
                  example: FacebookPixel
                  nullable: false
                pixelTrackingId:
                  type: string
                  description: 'The Pixel Tracking Id'
                  example: '282987392888293'
                  nullable: false
                description:
                  type: string
                  description: 'The description of the Team Pixel'
                  example: null
                  nullable: false
              required:
                - pixelType
                - pixelTrackingId
    parameters:
      -
        in: path
        name: team_id
        description: 'The ID of the team.'
        example: 9ffef0a7-e8a8-4d1b-98d1-fb819a02ded0
        required: true
        schema:
          type: string
  '/v1/team/{team_id}/pixels/{id}':
    get:
      summary: 'Retrieve a Team Pixel '
      operationId: retrieveATeamPixel
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  status: error
                  message: 'Access Denied'
                properties:
                  status:
                    type: string
                    example: error
                  message:
                    type: string
                    example: 'Access Denied'
      tags:
        - Team
    put:
      summary: 'Update Team Pixel '
      operationId: updateTeamPixel
      description: 'Update an existing Team Pixel.'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  status: error
                  message: 'Access Denied'
                properties:
                  status:
                    type: string
                    example: error
                  message:
                    type: string
                    example: 'Access Denied'
      tags:
        - Team
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                pixelType:
                  type: string
                  description: 'The Type Of Pixel'
                  example: null
                  nullable: false
                pixelTrackingId:
                  type: string
                  description: 'The Pixel Tracking Id'
                  example: null
                  nullable: false
                description:
                  type: string
                  description: 'Description of the Pixel'
                  example: null
                  nullable: false
              required:
                - pixelType
                - pixelTrackingId
    parameters:
      -
        in: path
        name: team_id
        description: 'The ID of the team.'
        example: 9ffef0a7-e8a8-4d1b-98d1-fb819a02ded0
        required: true
        schema:
          type: string
      -
        in: path
        name: id
        description: 'The ID of the pixel.'
        example: 000de240-676e-467e-988e-c10067cc36e3
        required: true
        schema:
          type: string
  '/v1/team/{team_id}/pixels/{pixel_id}/force':
    delete:
      summary: 'Permanently Delete Team Pixel '
      operationId: permanentlyDeleteTeamPixel
      description: 'Permanently delete a Team Pixel'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  status: success
                properties:
                  status:
                    type: string
                    example: success
      tags:
        - Team
    parameters:
      -
        in: path
        name: team_id
        description: 'The uuid of the team'
        example: 036a5473-f481-4630-8d5b-3fc405badeaf
        required: true
        schema:
          type: string
      -
        in: path
        name: pixel_id
        description: 'The uuid of the Team Pixel'
        example: 8a8cfd8d-fa16-4ef7-ac9d-5eb0b9bfa8c9
        required: true
        schema:
          type: string
  '/v1/team/{team_id}/prolinks':
    get:
      summary: 'Retrieve a list of ProLinks'
      operationId: retrieveAListOfProLinks
      description: 'Returns ProLinks for the specified team. ProLinks can be filtered and ordered.'
      parameters:
        -
          in: query
          name: 'filter[status]'
          description: 'Filter by the status of the ProLink. Defaults To published when not provided.'
          example: published
          required: false
          schema:
            type: string
            description: 'Filter by the status of the ProLink. Defaults To published when not provided.'
            example: published
            nullable: false
            enum:
              - draft
              - published
              - archived
              - deleted
        -
          in: query
          name: 'filter[campaignId]'
          description: 'Filter by Campaign ID.'
          example: null
          required: false
          schema:
            type: string
            description: 'Filter by Campaign ID.'
            example: null
            nullable: false
        -
          in: query
          name: 'filter[domainId]'
          description: 'Filter by Domain ID.'
          example: null
          required: false
          schema:
            type: string
            description: 'Filter by Domain ID.'
            example: null
            nullable: false
        -
          in: query
          name: 'filter[createdBy]'
          description: 'Filter by the user that created the ProLink.'
          example: null
          required: false
          schema:
            type: string
            description: 'Filter by the user that created the ProLink.'
            example: null
            nullable: false
        -
          in: query
          name: 'filter[updatedBy]'
          description: 'Filter by the user that last updated the ProLink.'
          example: null
          required: false
          schema:
            type: string
            description: 'Filter by the user that last updated the ProLink.'
            example: null
            nullable: false
        -
          in: query
          name: 'filter[createdAt]'
          description: 'Filter by Date the ProLink was created. You can filter for a specific date or before/after a certain date by prefixing with ><.'
          example: '>2025-01-01'
          required: false
          schema:
            type: string
            description: 'Filter by Date the ProLink was created. You can filter for a specific date or before/after a certain date by prefixing with ><.'
            example: '>2025-01-01'
            nullable: false
        -
          in: query
          name: 'filter[updatedAt]'
          description: 'Filter by Date the ProLink was updated. You can filter for a specific date or before/after a certain date by prefixing with ><.'
          example: '<2025-03-01'
          required: false
          schema:
            type: string
            description: 'Filter by Date the ProLink was updated. You can filter for a specific date or before/after a certain date by prefixing with ><.'
            example: '<2025-03-01'
            nullable: false
        -
          in: query
          name: 'filter[urlKey]'
          description: 'Filter by the "back half". Partial search, wildcards are not needed.'
          example: null
          required: false
          schema:
            type: string
            description: 'Filter by the "back half". Partial search, wildcards are not needed.'
            example: null
            nullable: false
        -
          in: query
          name: 'filter[destinationUrl]'
          description: 'Filter by the default destination url of the ProLink. Partial search, wildcards are not needed.'
          example: null
          required: false
          schema:
            type: string
            description: 'Filter by the default destination url of the ProLink. Partial search, wildcards are not needed.'
            example: null
            nullable: false
        -
          in: query
          name: 'filter[description]'
          description: 'Filter by the description of the ProLink. Partial search, wildcards are not needed.'
          example: null
          required: false
          schema:
            type: string
            description: 'Filter by the description of the ProLink. Partial search, wildcards are not needed.'
            example: null
            nullable: false
        -
          in: query
          name: 'filter[title]'
          description: 'Filter by the title of the destination page. Partial search, wildcards are not needed.'
          example: null
          required: false
          schema:
            type: string
            description: 'Filter by the title of the destination page. Partial search, wildcards are not needed.'
            example: null
            nullable: false
        -
          in: query
          name: sort
          description: 'Sort the results by urlKey, createdAt, or updatedAt.  Prefix with - to sort descending.'
          example: '-updatedAt,urlKey'
          required: false
          schema:
            type: string
            description: 'Sort the results by urlKey, createdAt, or updatedAt.  Prefix with - to sort descending.'
            example: '-updatedAt,urlKey'
            nullable: false
      responses: {  }
      tags:
        - ProLinks
    post:
      summary: 'Create a ProLink'
      operationId: createAProLink
      description: 'Creates a new ProLink for the specified team.  A domain host must be provided.'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                oneOf:
                  -
                    description: ''
                    type: object
                    example:
                      id: 000de240-ef2b-4e41-a931-182320360306
                      teamId: 000de240-2e36-4621-a3fb-782db631e683
                      campaignId: 000de240-ecd8-4234-be2b-1f5415d4db7c
                      apiHash: rfhjb5QBNgc37HuwFdEyDC4J8MnipT
                      urlKey: 8UxRT
                      destinationUrl: 'https://301pro.com/solutions'
                      domainId: 9ed5ce3a-7698-46f4-9fc3-83d18b9942d2
                      domainHost: demo.301.pro
                      status: published
                      title: '301.Pro Link Manager'
                      description: '301.Pro - Enterprise Link Management'
                      destinationMetaName:
                        author: 301Pro
                        viewport: 'width=device-width, initial-scale=1.0'
                        description: '301.Pro - Enterprise Link Management'
                        'twitter:card': summary_large_image
                        'twitter:site': '@301pro'
                        'twitter:image': 'https://www.301.Pro/images/app/prolinks.jpg'
                        'twitter:title': '301Pro - Enterprise Link Management'
                        'twitter:description': 'Premium advertising and marketing solutions for enterprise and agency logos'
                      destinationMetaProperty:
                        'og:type': website
                        'og:image': 'https://www.301.Pro/images/app/prolinks.jpg'
                        'og:title': '301Pro - Enterprise Link Management'
                        'og:description': 'Premium advertising and marketing solutions for enterprise and agency logos'
                      customData: null
                      clicks: 0
                      createdAt: '2025-09-29T18:34:55.000000Z'
                      updatedAt: '2025-10-01T17:54:06.000000Z'
                    properties:
                      id:
                        type: string
                        example: 000de240-ef2b-4e41-a931-182320360306
                      teamId:
                        type: string
                        example: 000de240-2e36-4621-a3fb-782db631e683
                      campaignId:
                        type: string
                        example: 000de240-ecd8-4234-be2b-1f5415d4db7c
                      apiHash:
                        type: string
                        example: rfhjb5QBNgc37HuwFdEyDC4J8MnipT
                      urlKey:
                        type: string
                        example: 8UxRT
                      destinationUrl:
                        type: string
                        example: 'https://301pro.com/solutions'
                      domainId:
                        type: string
                        example: 9ed5ce3a-7698-46f4-9fc3-83d18b9942d2
                      domainHost:
                        type: string
                        example: demo.301.pro
                      status:
                        type: string
                        example: published
                      title:
                        type: string
                        example: '301.Pro Link Manager'
                      description:
                        type: string
                        example: '301.Pro - Enterprise Link Management'
                      destinationMetaName:
                        type: object
                        properties:
                          author:
                            type: string
                            example: 301Pro
                          viewport:
                            type: string
                            example: 'width=device-width, initial-scale=1.0'
                          description:
                            type: string
                            example: '301.Pro - Enterprise Link Management'
                          'twitter:card':
                            type: string
                            example: summary_large_image
                          'twitter:site':
                            type: string
                            example: '@301pro'
                          'twitter:image':
                            type: string
                            example: 'https://www.301.Pro/images/app/prolinks.jpg'
                          'twitter:title':
                            type: string
                            example: '301Pro - Enterprise Link Management'
                          'twitter:description':
                            type: string
                            example: 'Premium advertising and marketing solutions for enterprise and agency logos'
                      destinationMetaProperty:
                        type: object
                        properties:
                          'og:type':
                            type: string
                            example: website
                          'og:image':
                            type: string
                            example: 'https://www.301.Pro/images/app/prolinks.jpg'
                          'og:title':
                            type: string
                            example: '301Pro - Enterprise Link Management'
                          'og:description':
                            type: string
                            example: 'Premium advertising and marketing solutions for enterprise and agency logos'
                      customData:
                        type: string
                        example: null
                      clicks:
                        type: integer
                        example: 0
                      createdAt:
                        type: string
                        example: '2025-09-29T18:34:55.000000Z'
                      updatedAt:
                        type: string
                        example: '2025-10-01T17:54:06.000000Z'
                  -
                    description: ''
                    type: object
                    example:
                      id: 000de240-2e36-4621-a3fb-782db631e683
                      teamId: 9ec2a283-2874-4b0f-9591-f5da40240398
                      campaignId: 568afe18-1f03-4263-9ef6-c3054b6856bf
                      apiHash: vajhiQyANx4VF2wXnRqCcB7W5TDgbU
                      urlKey: my-key
                      destinationUrl: 'https://example.com/destination'
                      domainId: 9ec2a27e-00d1-44db-9dde-0c7641a8a7bf
                      domainHost: example.com
                      status: published
                      title: 'About Us'
                      description: 'This is a description for the About Us section'
                      destinationMetaName: []
                      destinationMetaProperty: []
                      customData:
                        hubspotCampaignId: e5d960a2-8386-4884-a021-ac84d81eacd9
                        customKey2: customValue2
                      clicks: 0
                      createdAt: '2025-04-27T04:26:38.000000Z'
                      updatedAt: '2025-04-29T01:40:15.000000Z'
                      createdBy: 9ec2a283-2808-4c31-88ec-feb72578e089
                      updatedBy: 9ec2a283-2808-4c31-88ec-feb72578e089
                    properties:
                      id:
                        type: string
                        example: 000de240-2e36-4621-a3fb-782db631e683
                      teamId:
                        type: string
                        example: 9ec2a283-2874-4b0f-9591-f5da40240398
                      campaignId:
                        type: string
                        example: 568afe18-1f03-4263-9ef6-c3054b6856bf
                      apiHash:
                        type: string
                        example: vajhiQyANx4VF2wXnRqCcB7W5TDgbU
                      urlKey:
                        type: string
                        example: my-key
                      destinationUrl:
                        type: string
                        example: 'https://example.com/destination'
                      domainId:
                        type: string
                        example: 9ec2a27e-00d1-44db-9dde-0c7641a8a7bf
                      domainHost:
                        type: string
                        example: example.com
                      status:
                        type: string
                        example: published
                      title:
                        type: string
                        example: 'About Us'
                      description:
                        type: string
                        example: 'This is a description for the About Us section'
                      destinationMetaName:
                        type: array
                        example: []
                      destinationMetaProperty:
                        type: array
                        example: []
                      customData:
                        type: object
                        properties:
                          hubspotCampaignId:
                            type: string
                            example: e5d960a2-8386-4884-a021-ac84d81eacd9
                          customKey2:
                            type: string
                            example: customValue2
                      clicks:
                        type: integer
                        example: 0
                      createdAt:
                        type: string
                        example: '2025-04-27T04:26:38.000000Z'
                      updatedAt:
                        type: string
                        example: '2025-04-29T01:40:15.000000Z'
                      createdBy:
                        type: string
                        example: 9ec2a283-2808-4c31-88ec-feb72578e089
                      updatedBy:
                        type: string
                        example: 9ec2a283-2808-4c31-88ec-feb72578e089
      tags:
        - ProLinks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                domain:
                  type: string
                  description: 'The domain of the prolink.'
                  example: example.com
                  nullable: false
                urlKey:
                  type: string
                  description: 'The "back half" of the url key.'
                  example: my-key
                  nullable: false
                destinationUrl:
                  type: string
                  description: 'The default destination url of the ProLink.'
                  example: 'https://example.com/destination'
                  nullable: false
                title:
                  type: string
                  description: 'The title of the destination page.'
                  example: 'About Us'
                  nullable: false
                description:
                  type: string
                  description: 'The description of the ProLink.'
                  example: 'This is a description for the About Us section'
                  nullable: false
                campaignId:
                  type: string
                  description: 'The ID of the campaign.'
                  example: 568afe18-1f03-4263-9ef6-c3054b6856bf
                  nullable: false
                customData:
                  type: object
                  description: 'Custom Data assigned to this Pro Link. Example: {"hubspotCampaignId": "e5d960a2-8386-4884-a021-ac84d81eacd9", "customKey2": "customValue2"}'
                  example:
                    hubspotCampaignId: e5d960a2-8386-4884-a021-ac84d81eacd9
                    customKey2: customValue2
                  nullable: false
                  properties: {  }
              required:
                - domain
                - destinationUrl
    parameters:
      -
        in: path
        name: team_id
        description: 'The ID of the team.'
        example: 9ffef0a7-e8a8-4d1b-98d1-fb819a02ded0
        required: true
        schema:
          type: string
  '/v1/team/{team_id}/prolinks/{id}':
    get:
      summary: 'Retrieve a ProLink'
      operationId: retrieveAProLink
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                oneOf:
                  -
                    description: ''
                    type: object
                    example:
                      id: 000de240-ef2b-4e41-a931-182320360306
                      teamId: 000de240-2e36-4621-a3fb-782db631e683
                      campaignId: 000de240-ecd8-4234-be2b-1f5415d4db7c
                      apiHash: rfhjb5QBNgc37HuwFdEyDC4J8MnipT
                      urlKey: 8UxRT
                      destinationUrl: 'https://301pro.com/solutions'
                      domainId: 9ed5ce3a-7698-46f4-9fc3-83d18b9942d2
                      domainHost: demo.301.pro
                      status: published
                      title: '301.Pro Link Manager'
                      description: '301.Pro - Enterprise Link Management'
                      destinationMetaName:
                        author: 301Pro
                        viewport: 'width=device-width, initial-scale=1.0'
                        description: '301.Pro - Enterprise Link Management'
                        'twitter:card': summary_large_image
                        'twitter:site': '@301pro'
                        'twitter:image': 'https://www.301.Pro/images/app/prolinks.jpg'
                        'twitter:title': '301Pro - Enterprise Link Management'
                        'twitter:description': 'Premium advertising and marketing solutions for enterprise and agency logos'
                      destinationMetaProperty:
                        'og:type': website
                        'og:image': 'https://www.301.Pro/images/app/prolinks.jpg'
                        'og:title': '301Pro - Enterprise Link Management'
                        'og:description': 'Premium advertising and marketing solutions for enterprise and agency logos'
                      customData: null
                      clicks: 0
                      createdAt: '2025-09-29T18:34:55.000000Z'
                      updatedAt: '2025-10-01T17:54:06.000000Z'
                    properties:
                      id:
                        type: string
                        example: 000de240-ef2b-4e41-a931-182320360306
                      teamId:
                        type: string
                        example: 000de240-2e36-4621-a3fb-782db631e683
                      campaignId:
                        type: string
                        example: 000de240-ecd8-4234-be2b-1f5415d4db7c
                      apiHash:
                        type: string
                        example: rfhjb5QBNgc37HuwFdEyDC4J8MnipT
                      urlKey:
                        type: string
                        example: 8UxRT
                      destinationUrl:
                        type: string
                        example: 'https://301pro.com/solutions'
                      domainId:
                        type: string
                        example: 9ed5ce3a-7698-46f4-9fc3-83d18b9942d2
                      domainHost:
                        type: string
                        example: demo.301.pro
                      status:
                        type: string
                        example: published
                      title:
                        type: string
                        example: '301.Pro Link Manager'
                      description:
                        type: string
                        example: '301.Pro - Enterprise Link Management'
                      destinationMetaName:
                        type: object
                        properties:
                          author:
                            type: string
                            example: 301Pro
                          viewport:
                            type: string
                            example: 'width=device-width, initial-scale=1.0'
                          description:
                            type: string
                            example: '301.Pro - Enterprise Link Management'
                          'twitter:card':
                            type: string
                            example: summary_large_image
                          'twitter:site':
                            type: string
                            example: '@301pro'
                          'twitter:image':
                            type: string
                            example: 'https://www.301.Pro/images/app/prolinks.jpg'
                          'twitter:title':
                            type: string
                            example: '301Pro - Enterprise Link Management'
                          'twitter:description':
                            type: string
                            example: 'Premium advertising and marketing solutions for enterprise and agency logos'
                      destinationMetaProperty:
                        type: object
                        properties:
                          'og:type':
                            type: string
                            example: website
                          'og:image':
                            type: string
                            example: 'https://www.301.Pro/images/app/prolinks.jpg'
                          'og:title':
                            type: string
                            example: '301Pro - Enterprise Link Management'
                          'og:description':
                            type: string
                            example: 'Premium advertising and marketing solutions for enterprise and agency logos'
                      customData:
                        type: string
                        example: null
                      clicks:
                        type: integer
                        example: 0
                      createdAt:
                        type: string
                        example: '2025-09-29T18:34:55.000000Z'
                      updatedAt:
                        type: string
                        example: '2025-10-01T17:54:06.000000Z'
                  -
                    description: ''
                    type: object
                    example:
                      id: 000de240-2e36-4621-a3fb-782db631e683
                      teamId: 9ec2a283-2874-4b0f-9591-f5da40240398
                      campaignId: 568afe18-1f03-4263-9ef6-c3054b6856bf
                      apiHash: vajhiQyANx4VF2wXnRqCcB7W5TDgbU
                      urlKey: my-key
                      destinationUrl: 'https://example.com/destination'
                      domainId: 9ec2a27e-00d1-44db-9dde-0c7641a8a7bf
                      domainHost: example.com
                      status: published
                      title: 'About Us'
                      description: 'This is a description for the About Us section'
                      destinationMetaName: []
                      destinationMetaProperty: []
                      customData:
                        hubspotCampaignId: e5d960a2-8386-4884-a021-ac84d81eacd9
                        customKey2: customValue2
                      clicks: 0
                      createdAt: '2025-04-27T04:26:38.000000Z'
                      updatedAt: '2025-04-29T01:40:15.000000Z'
                      createdBy: 9ec2a283-2808-4c31-88ec-feb72578e089
                      updatedBy: 9ec2a283-2808-4c31-88ec-feb72578e089
                    properties:
                      id:
                        type: string
                        example: 000de240-2e36-4621-a3fb-782db631e683
                      teamId:
                        type: string
                        example: 9ec2a283-2874-4b0f-9591-f5da40240398
                      campaignId:
                        type: string
                        example: 568afe18-1f03-4263-9ef6-c3054b6856bf
                      apiHash:
                        type: string
                        example: vajhiQyANx4VF2wXnRqCcB7W5TDgbU
                      urlKey:
                        type: string
                        example: my-key
                      destinationUrl:
                        type: string
                        example: 'https://example.com/destination'
                      domainId:
                        type: string
                        example: 9ec2a27e-00d1-44db-9dde-0c7641a8a7bf
                      domainHost:
                        type: string
                        example: example.com
                      status:
                        type: string
                        example: published
                      title:
                        type: string
                        example: 'About Us'
                      description:
                        type: string
                        example: 'This is a description for the About Us section'
                      destinationMetaName:
                        type: array
                        example: []
                      destinationMetaProperty:
                        type: array
                        example: []
                      customData:
                        type: object
                        properties:
                          hubspotCampaignId:
                            type: string
                            example: e5d960a2-8386-4884-a021-ac84d81eacd9
                          customKey2:
                            type: string
                            example: customValue2
                      clicks:
                        type: integer
                        example: 0
                      createdAt:
                        type: string
                        example: '2025-04-27T04:26:38.000000Z'
                      updatedAt:
                        type: string
                        example: '2025-04-29T01:40:15.000000Z'
                      createdBy:
                        type: string
                        example: 9ec2a283-2808-4c31-88ec-feb72578e089
                      updatedBy:
                        type: string
                        example: 9ec2a283-2808-4c31-88ec-feb72578e089
      tags:
        - ProLinks
    put:
      summary: 'Update a ProLink'
      operationId: updateAProLink
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                oneOf:
                  -
                    description: ''
                    type: object
                    example:
                      id: 000de240-ef2b-4e41-a931-182320360306
                      teamId: 000de240-2e36-4621-a3fb-782db631e683
                      campaignId: 000de240-ecd8-4234-be2b-1f5415d4db7c
                      apiHash: rfhjb5QBNgc37HuwFdEyDC4J8MnipT
                      urlKey: 8UxRT
                      destinationUrl: 'https://301pro.com/solutions'
                      domainId: 9ed5ce3a-7698-46f4-9fc3-83d18b9942d2
                      domainHost: demo.301.pro
                      status: published
                      title: '301.Pro Link Manager'
                      description: '301.Pro - Enterprise Link Management'
                      destinationMetaName:
                        author: 301Pro
                        viewport: 'width=device-width, initial-scale=1.0'
                        description: '301.Pro - Enterprise Link Management'
                        'twitter:card': summary_large_image
                        'twitter:site': '@301pro'
                        'twitter:image': 'https://www.301.Pro/images/app/prolinks.jpg'
                        'twitter:title': '301Pro - Enterprise Link Management'
                        'twitter:description': 'Premium advertising and marketing solutions for enterprise and agency logos'
                      destinationMetaProperty:
                        'og:type': website
                        'og:image': 'https://www.301.Pro/images/app/prolinks.jpg'
                        'og:title': '301Pro - Enterprise Link Management'
                        'og:description': 'Premium advertising and marketing solutions for enterprise and agency logos'
                      customData: null
                      clicks: 0
                      createdAt: '2025-09-29T18:34:55.000000Z'
                      updatedAt: '2025-10-01T17:54:06.000000Z'
                    properties:
                      id:
                        type: string
                        example: 000de240-ef2b-4e41-a931-182320360306
                      teamId:
                        type: string
                        example: 000de240-2e36-4621-a3fb-782db631e683
                      campaignId:
                        type: string
                        example: 000de240-ecd8-4234-be2b-1f5415d4db7c
                      apiHash:
                        type: string
                        example: rfhjb5QBNgc37HuwFdEyDC4J8MnipT
                      urlKey:
                        type: string
                        example: 8UxRT
                      destinationUrl:
                        type: string
                        example: 'https://301pro.com/solutions'
                      domainId:
                        type: string
                        example: 9ed5ce3a-7698-46f4-9fc3-83d18b9942d2
                      domainHost:
                        type: string
                        example: demo.301.pro
                      status:
                        type: string
                        example: published
                      title:
                        type: string
                        example: '301.Pro Link Manager'
                      description:
                        type: string
                        example: '301.Pro - Enterprise Link Management'
                      destinationMetaName:
                        type: object
                        properties:
                          author:
                            type: string
                            example: 301Pro
                          viewport:
                            type: string
                            example: 'width=device-width, initial-scale=1.0'
                          description:
                            type: string
                            example: '301.Pro - Enterprise Link Management'
                          'twitter:card':
                            type: string
                            example: summary_large_image
                          'twitter:site':
                            type: string
                            example: '@301pro'
                          'twitter:image':
                            type: string
                            example: 'https://www.301.Pro/images/app/prolinks.jpg'
                          'twitter:title':
                            type: string
                            example: '301Pro - Enterprise Link Management'
                          'twitter:description':
                            type: string
                            example: 'Premium advertising and marketing solutions for enterprise and agency logos'
                      destinationMetaProperty:
                        type: object
                        properties:
                          'og:type':
                            type: string
                            example: website
                          'og:image':
                            type: string
                            example: 'https://www.301.Pro/images/app/prolinks.jpg'
                          'og:title':
                            type: string
                            example: '301Pro - Enterprise Link Management'
                          'og:description':
                            type: string
                            example: 'Premium advertising and marketing solutions for enterprise and agency logos'
                      customData:
                        type: string
                        example: null
                      clicks:
                        type: integer
                        example: 0
                      createdAt:
                        type: string
                        example: '2025-09-29T18:34:55.000000Z'
                      updatedAt:
                        type: string
                        example: '2025-10-01T17:54:06.000000Z'
                  -
                    description: ''
                    type: object
                    example:
                      id: 000de240-2e36-4621-a3fb-782db631e683
                      teamId: 9ec2a283-2874-4b0f-9591-f5da40240398
                      campaignId: 568afe18-1f03-4263-9ef6-c3054b6856bf
                      apiHash: vajhiQyANx4VF2wXnRqCcB7W5TDgbU
                      urlKey: my-key
                      destinationUrl: 'https://example.com/destination'
                      domainId: 9ec2a27e-00d1-44db-9dde-0c7641a8a7bf
                      domainHost: example.com
                      status: published
                      title: 'About Us'
                      description: 'This is a description for the About Us section'
                      destinationMetaName: []
                      destinationMetaProperty: []
                      customData:
                        hubspotCampaignId: e5d960a2-8386-4884-a021-ac84d81eacd9
                        customKey2: customValue2
                      clicks: 0
                      createdAt: '2025-04-27T04:26:38.000000Z'
                      updatedAt: '2025-04-29T01:40:15.000000Z'
                      createdBy: 9ec2a283-2808-4c31-88ec-feb72578e089
                      updatedBy: 9ec2a283-2808-4c31-88ec-feb72578e089
                    properties:
                      id:
                        type: string
                        example: 000de240-2e36-4621-a3fb-782db631e683
                      teamId:
                        type: string
                        example: 9ec2a283-2874-4b0f-9591-f5da40240398
                      campaignId:
                        type: string
                        example: 568afe18-1f03-4263-9ef6-c3054b6856bf
                      apiHash:
                        type: string
                        example: vajhiQyANx4VF2wXnRqCcB7W5TDgbU
                      urlKey:
                        type: string
                        example: my-key
                      destinationUrl:
                        type: string
                        example: 'https://example.com/destination'
                      domainId:
                        type: string
                        example: 9ec2a27e-00d1-44db-9dde-0c7641a8a7bf
                      domainHost:
                        type: string
                        example: example.com
                      status:
                        type: string
                        example: published
                      title:
                        type: string
                        example: 'About Us'
                      description:
                        type: string
                        example: 'This is a description for the About Us section'
                      destinationMetaName:
                        type: array
                        example: []
                      destinationMetaProperty:
                        type: array
                        example: []
                      customData:
                        type: object
                        properties:
                          hubspotCampaignId:
                            type: string
                            example: e5d960a2-8386-4884-a021-ac84d81eacd9
                          customKey2:
                            type: string
                            example: customValue2
                      clicks:
                        type: integer
                        example: 0
                      createdAt:
                        type: string
                        example: '2025-04-27T04:26:38.000000Z'
                      updatedAt:
                        type: string
                        example: '2025-04-29T01:40:15.000000Z'
                      createdBy:
                        type: string
                        example: 9ec2a283-2808-4c31-88ec-feb72578e089
                      updatedBy:
                        type: string
                        example: 9ec2a283-2808-4c31-88ec-feb72578e089
      tags:
        - ProLinks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                domain:
                  type: string
                  description: 'The domain of the prolink.'
                  example: example.com
                  nullable: false
                urlKey:
                  type: string
                  description: 'The "back half" of the url key.'
                  example: my-key
                  nullable: false
                destinationUrl:
                  type: string
                  description: 'The default destination url of the ProLink.'
                  example: 'https://example.com/destination'
                  nullable: false
                title:
                  type: string
                  description: 'The title of the destination page.'
                  example: 'About Us'
                  nullable: false
                description:
                  type: string
                  description: 'The description of the ProLink.'
                  example: 'This is a description for the About Us section'
                  nullable: false
                campaignId:
                  type: string
                  description: 'The ID of the campaign.'
                  example: 568afe18-1f03-4263-9ef6-c3054b6856bf
                  nullable: false
                destinationMetaName:
                  type: object
                  description: 'The meta name object from the destination page.'
                  example: null
                  nullable: false
                  properties: {  }
                destinationMetaProperty:
                  type: object
                  description: 'The meta property object of the destination page.'
                  example: null
                  nullable: false
                  properties: {  }
                customData:
                  type: object
                  description: 'Custom Data assigned to this Pro Link. Example: {"hubspotCampaignId": "e5d960a2-8386-4884-a021-ac84d81eacd9", "customKey2": "customValue2"}'
                  example:
                    hubspotCampaignId: e5d960a2-8386-4884-a021-ac84d81eacd9
                    customKey2: customValue2
                  nullable: false
                  properties: {  }
              required:
                - domain
                - urlKey
                - destinationUrl
    delete:
      summary: 'Delete ProLink'
      operationId: deleteProLink
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  status: success
                properties:
                  status:
                    type: string
                    example: success
      tags:
        - ProLinks
    parameters:
      -
        in: path
        name: team_id
        description: 'The ID of the team.'
        example: 9ffef0a7-e8a8-4d1b-98d1-fb819a02ded0
        required: true
        schema:
          type: string
      -
        in: path
        name: id
        description: 'The ID of the prolink.'
        example: 000de240-ef2b-4e41-a931-182320360306
        required: true
        schema:
          type: string
  '/v1/team/{team}/prolinks/batch/create':
    post:
      summary: 'Batch Create ProLinks'
      operationId: batchCreateProLinks
      description: 'Creates new ProLinks for the specified team.  A domain host must be provided for each ProLink.'
      parameters: []
      responses:
        200:
          description: ''
          content:
            text/plain:
              schema:
                type: string
                example: "{\n    \"proLinks\": [\n        {\n            \"urlKey\": \"dnJseU8bn\",\n            \"destinationUrl\": \"https://example.com/destination\",\n            \"teamDomainId\": \"a002db18-2d35-447e-8db7-dfefc665e90b\",\n            \"domainId\": \"9ec2a27e-00d1-44db-9dde-0c7641a8a7bf\",\n            \"domainHost\": \"example.com\",\n            \"status\": \"draft\",\n            \"title\": \"About Us\",\n            \"description\": \"This is a description for the About Us section\",\n            \"customData\": {\n                \"hubspotCampaignId\": \"e5d960a2-8386-4884-a021-ac84d81eacd9\",\n                \"customKey2\": \"customValue2\"\n            },\n        }\n    ]\n}\n\n"
      tags:
        - ProLinks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                proLinks:
                  type: array
                  description: 'ProLinks to be created'
                  example:
                    - []
                  items:
                    type: object
                    properties:
                      domain:
                        type: string
                        description: 'The domain of the prolink.'
                        example: example.com
                        nullable: false
                      urlKey:
                        type: string
                        description: 'The "back half" of the url key.'
                        example: my-key
                        nullable: false
                      destinationUrl:
                        type: string
                        description: 'The default destination url of the ProLink.'
                        example: 'https://example.com/destination'
                        nullable: false
                      title:
                        type: string
                        description: 'The title of the destination page.'
                        example: 'About Us'
                        nullable: false
                      description:
                        type: string
                        description: 'The description of the ProLink.'
                        example: 'This is a description for the About Us section'
                        nullable: false
                      campaignId:
                        type: string
                        description: 'The ID of the campaign.'
                        example: 568afe18-1f03-4263-9ef6-c3054b6856bf
                        nullable: false
                      customData:
                        type: object
                        description: 'Custom Data assigned to this Pro Link.'
                        example:
                          hubspotCampaignId: e5d960a2-8386-4884-a021-ac84d81eacd9
                          customKey2: customValue2
                        nullable: false
                        properties: {  }
                    required:
                      - domain
                      - destinationUrl
              required:
                - proLinks
    parameters:
      -
        in: path
        name: team
        description: 'The team.'
        example: 9ffef0a7-e8a8-4d1b-98d1-fb819a02ded0
        required: true
        schema:
          type: string
  '/v1/team/{team_id}/prolinks/archive':
    post:
      summary: 'Archive a collection of ProLinks'
      operationId: archiveACollectionOfProLinks
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  status: success
                properties:
                  status:
                    type: string
                    example: success
      tags:
        - ProLinks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                ids:
                  type: array
                  description: 'An array of ProLink IDs.'
                  example:
                    - f706b628-8412-4303-b4e1-74c197f1052d
                    - 889dd662-d418-4c77-a2cd-78553553d6b8
                    - 59b41355-9c68-473f-883c-0c950501c1da
                  items:
                    type: string
              required:
                - ids
    parameters:
      -
        in: path
        name: team_id
        description: 'The ID of the team.'
        example: 9ffef0a7-e8a8-4d1b-98d1-fb819a02ded0
        required: true
        schema:
          type: string
  '/v1/team/{team_id}/prolinks/unarchive':
    post:
      summary: 'Remove archive status from a collection of ProLinks'
      operationId: removeArchiveStatusFromACollectionOfProLinks
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  status: success
                properties:
                  status:
                    type: string
                    example: success
      tags:
        - ProLinks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                ids:
                  type: array
                  description: 'An array of ProLink IDs.'
                  example:
                    - f706b628-8412-4303-b4e1-74c197f1052d
                    - 889dd662-d418-4c77-a2cd-78553553d6b8
                    - 59b41355-9c68-473f-883c-0c950501c1da
                  items:
                    type: string
              required:
                - ids
    parameters:
      -
        in: path
        name: team_id
        description: 'The ID of the team.'
        example: 9ffef0a7-e8a8-4d1b-98d1-fb819a02ded0
        required: true
        schema:
          type: string
  '/v1/team/{team_id}/prolinks/{prolink_id}/labels/attach':
    post:
      summary: 'Assign Labels'
      operationId: assignLabels
      description: 'Assign labels to a ProLink.'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  status: success
                properties:
                  status:
                    type: string
                    example: success
      tags:
        - ProLinks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                ids:
                  type: array
                  description: "The uuid's of the label to assign to the ProLink"
                  example:
                    - 9e545a7c-864e-41f4-8f9a-6eeba429f35d
                  items:
                    type: string
              required:
                - ids
    parameters:
      -
        in: path
        name: team_id
        description: 'The uuid of the team'
        example: b3f6222c-5e38-4357-b831-0a24a7886a03
        required: true
        schema:
          type: string
      -
        in: path
        name: prolink_id
        description: 'The uuid of the ProLink'
        example: a6122210-e83a-4667-83ae-b7f05e3a2c47
        required: true
        schema:
          type: string
  '/v1/team/{team_id}/prolinks/{prolink_id}/labels/detach':
    post:
      summary: 'Unassign Labels'
      operationId: unassignLabels
      description: 'Remove label assignment from a ProLink.'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  status: success
                properties:
                  status:
                    type: string
                    example: success
      tags:
        - ProLinks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                ids:
                  type: array
                  description: "The uuid's of the label to remove from the ProLink"
                  example:
                    - 9e545a7c-864e-41f4-8f9a-6eeba429f35d
                  items:
                    type: string
              required:
                - ids
    parameters:
      -
        in: path
        name: team_id
        description: 'The uuid of the team'
        example: fd8ecc00-d0a1-4cbb-97af-68aa37db8c71
        required: true
        schema:
          type: string
      -
        in: path
        name: prolink_id
        description: 'The uuid of the ProLink'
        example: ef8f3203-7d43-49af-a9b6-54ec3b9f09fb
        required: true
        schema:
          type: string
  '/v1/team/{team_id}/prolinks/{prolink_id}/labels/sync':
    post:
      summary: 'Sync Labels'
      operationId: syncLabels
      description: 'Add or remove label assignments from a ProLink in a single request.'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  status: success
                properties:
                  status:
                    type: string
                    example: success
      tags:
        - ProLinks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                ids:
                  type: array
                  description: "The uuid's of the label to assign and or remove from the ProLink"
                  example:
                    - 9e545a7c-864e-41f4-8f9a-6eeba429f35d
                  items:
                    type: string
              required:
                - ids
    parameters:
      -
        in: path
        name: team_id
        description: 'The uuid of the team'
        example: e1b37072-0b8e-4b5b-ae81-ff53dca8c726
        required: true
        schema:
          type: string
      -
        in: path
        name: prolink_id
        description: 'The uuid of the ProLink'
        example: 476d29f3-0656-4852-ad07-d59bd67973be
        required: true
        schema:
          type: string
  '/v1/team/{team_id}/prolinks/{prolink_id}/force':
    delete:
      summary: 'Permanently delete the specified ProLink'
      operationId: permanentlyDeleteTheSpecifiedProLink
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  status: success
                properties:
                  status:
                    type: string
                    example: success
      tags:
        - ProLinks
    parameters:
      -
        in: path
        name: team_id
        description: 'The ID of the team.'
        example: 9ffef0a7-e8a8-4d1b-98d1-fb819a02ded0
        required: true
        schema:
          type: string
      -
        in: path
        name: prolink_id
        description: 'The ID of the prolink.'
        example: 000de240-ef2b-4e41-a931-182320360306
        required: true
        schema:
          type: string
  '/v1/team/{team_id}/prolinks/{prolink_id}/restore':
    post:
      summary: 'Undelete a ProLink'
      operationId: undeleteAProLink
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  status: success
                properties:
                  status:
                    type: string
                    example: success
      tags:
        - ProLinks
    parameters:
      -
        in: path
        name: team_id
        description: 'The ID of the team.'
        example: 9ffef0a7-e8a8-4d1b-98d1-fb819a02ded0
        required: true
        schema:
          type: string
      -
        in: path
        name: prolink_id
        description: 'The ID of the prolink.'
        example: 000de240-ef2b-4e41-a931-182320360306
        required: true
        schema:
          type: string
  '/v1/team/{team_id}/campaigns':
    get:
      summary: 'Retrieve a list of Campaigns'
      operationId: retrieveAListOfCampaigns
      description: ''
      parameters:
        -
          in: query
          name: 'filter[status]'
          description: 'Filter by Status. Defaults To published when not provided.'
          example: archived
          required: false
          schema:
            type: string
            description: 'Filter by Status. Defaults To published when not provided.'
            example: archived
            nullable: false
            enum:
              - draft
              - published
              - deleted
        -
          in: query
          name: 'filter[name]'
          description: 'Filter by Campaign name.  Wildcards are not needed.'
          example: '"Email"'
          required: false
          schema:
            type: string
            description: 'Filter by Campaign name.  Wildcards are not needed.'
            example: '"Email"'
            nullable: false
        -
          in: query
          name: 'filter[description]'
          description: 'Filter by Campaign Description. Wildcards are not needed.'
          example: '"customer"'
          required: false
          schema:
            type: string
            description: 'Filter by Campaign Description. Wildcards are not needed.'
            example: '"customer"'
            nullable: false
        -
          in: query
          name: 'filter[createdBy]'
          description: 'Filter by User ID that created the Campaign.'
          example: 568afe18-1f03-4263-9ef6-c3054b6856bf
          required: false
          schema:
            type: string
            description: 'Filter by User ID that created the Campaign.'
            example: 568afe18-1f03-4263-9ef6-c3054b6856bf
            nullable: false
        -
          in: query
          name: 'filter[updatedBy]'
          description: 'Filter by User ID that last updated the Campaign.'
          example: 568afe18-1f03-4263-9ef6-c3054b6856bf
          required: false
          schema:
            type: string
            description: 'Filter by User ID that last updated the Campaign.'
            example: 568afe18-1f03-4263-9ef6-c3054b6856bf
            nullable: false
        -
          in: query
          name: 'filter[createdAt]'
          description: 'Filter by date the Campaign was created. You can filter for a specific date or before/after a certain date by prefixing with > or <.'
          example: '>2025-01-01'
          required: false
          schema:
            type: string
            description: 'Filter by date the Campaign was created. You can filter for a specific date or before/after a certain date by prefixing with > or <.'
            example: '>2025-01-01'
            nullable: false
        -
          in: query
          name: 'filter[updatedAt]'
          description: 'Filter by date the Campaign was updated. You can filter for a specific date or before/after a certain date by prefixing with > or <.'
          example: '<2025-06-01'
          required: false
          schema:
            type: string
            description: 'Filter by date the Campaign was updated. You can filter for a specific date or before/after a certain date by prefixing with > or <.'
            example: '<2025-06-01'
            nullable: false
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  status: error
                  message: 'Access Denied'
                properties:
                  status:
                    type: string
                    example: error
                  message:
                    type: string
                    example: 'Access Denied'
      tags:
        - Campaigns
    post:
      summary: 'Create a Campaign'
      operationId: createACampaign
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                oneOf:
                  -
                    description: ''
                    type: object
                    example:
                      id: a002dac1-1665-462e-822a-46b137e657ac
                      teamId: 9ed5d488-9940-4840-b979-617e080d8be9
                      name: 'CDE - Click Data Enrichment'
                      description: 'Add Click Data Enrichment (CDE) to each link'
                      status: published
                      createdAt: '2025-10-01T17:53:24.000000Z'
                      updatedAt: '2025-10-01T17:53:27.000000Z'
                    properties:
                      id:
                        type: string
                        example: a002dac1-1665-462e-822a-46b137e657ac
                      teamId:
                        type: string
                        example: 9ed5d488-9940-4840-b979-617e080d8be9
                      name:
                        type: string
                        example: 'CDE - Click Data Enrichment'
                      description:
                        type: string
                        example: 'Add Click Data Enrichment (CDE) to each link'
                      status:
                        type: string
                        example: published
                      createdAt:
                        type: string
                        example: '2025-10-01T17:53:24.000000Z'
                      updatedAt:
                        type: string
                        example: '2025-10-01T17:53:27.000000Z'
                  -
                    description: ''
                    type: object
                    example:
                      status: error
                      message: 'Access Denied'
                    properties:
                      status:
                        type: string
                        example: error
                      message:
                        type: string
                        example: 'Access Denied'
      tags:
        - Campaigns
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: 'The name of the campaign.'
                  example: 'CDE - Click Data Enrichment'
                  nullable: false
                description:
                  type: string
                  description: 'nullable The description of the campaign.'
                  example: 'Add Click Data Enrichment (CDE) to each link'
                  nullable: false
              required:
                - name
    parameters:
      -
        in: path
        name: team_id
        description: 'The ID of the team.'
        example: 9ffef0a7-e8a8-4d1b-98d1-fb819a02ded0
        required: true
        schema:
          type: string
  '/v1/team/{team_id}/campaigns/{id}':
    get:
      summary: 'Retrieve a Campaign'
      operationId: retrieveACampaign
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                oneOf:
                  -
                    description: ''
                    type: object
                    example:
                      id: a002dac1-1665-462e-822a-46b137e657ac
                      teamId: 9ed5d488-9940-4840-b979-617e080d8be9
                      name: 'CDE - Click Data Enrichment'
                      description: 'Add Click Data Enrichment (CDE) to each link'
                      status: published
                      createdAt: '2025-10-01T17:53:24.000000Z'
                      updatedAt: '2025-10-01T17:53:27.000000Z'
                    properties:
                      id:
                        type: string
                        example: a002dac1-1665-462e-822a-46b137e657ac
                      teamId:
                        type: string
                        example: 9ed5d488-9940-4840-b979-617e080d8be9
                      name:
                        type: string
                        example: 'CDE - Click Data Enrichment'
                      description:
                        type: string
                        example: 'Add Click Data Enrichment (CDE) to each link'
                      status:
                        type: string
                        example: published
                      createdAt:
                        type: string
                        example: '2025-10-01T17:53:24.000000Z'
                      updatedAt:
                        type: string
                        example: '2025-10-01T17:53:27.000000Z'
                  -
                    description: ''
                    type: object
                    example:
                      status: error
                      message: 'Access Denied'
                    properties:
                      status:
                        type: string
                        example: error
                      message:
                        type: string
                        example: 'Access Denied'
      tags:
        - Campaigns
    put:
      summary: 'Update a Campaign'
      operationId: updateACampaign
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                oneOf:
                  -
                    description: ''
                    type: object
                    example:
                      id: a002dac1-1665-462e-822a-46b137e657ac
                      teamId: 9ed5d488-9940-4840-b979-617e080d8be9
                      name: 'CDE - Click Data Enrichment'
                      description: 'Add Click Data Enrichment (CDE) to each link'
                      status: published
                      createdAt: '2025-10-01T17:53:24.000000Z'
                      updatedAt: '2025-10-01T17:53:27.000000Z'
                    properties:
                      id:
                        type: string
                        example: a002dac1-1665-462e-822a-46b137e657ac
                      teamId:
                        type: string
                        example: 9ed5d488-9940-4840-b979-617e080d8be9
                      name:
                        type: string
                        example: 'CDE - Click Data Enrichment'
                      description:
                        type: string
                        example: 'Add Click Data Enrichment (CDE) to each link'
                      status:
                        type: string
                        example: published
                      createdAt:
                        type: string
                        example: '2025-10-01T17:53:24.000000Z'
                      updatedAt:
                        type: string
                        example: '2025-10-01T17:53:27.000000Z'
                  -
                    description: ''
                    type: object
                    example:
                      status: error
                      message: 'Access Denied'
                    properties:
                      status:
                        type: string
                        example: error
                      message:
                        type: string
                        example: 'Access Denied'
      tags:
        - Campaigns
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: 'The name of the campaign.'
                  example: 'Email Campaign'
                  nullable: false
                description:
                  type: string
                  description: 'nullable The description of the campaign.'
                  example: "Followup technical support email's"
                  nullable: false
              required:
                - name
    delete:
      summary: 'Delete a Campaign'
      operationId: deleteACampaign
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  status: success
                properties:
                  status:
                    type: string
                    example: success
      tags:
        - Campaigns
    parameters:
      -
        in: path
        name: team_id
        description: 'The ID of the team.'
        example: 9ffef0a7-e8a8-4d1b-98d1-fb819a02ded0
        required: true
        schema:
          type: string
      -
        in: path
        name: id
        description: 'The ID of the campaign.'
        example: a002dac1-1665-462e-822a-46b137e657ac
        required: true
        schema:
          type: string
  '/v1/team/{team_id}/campaigns/{campaign_id}/pixels':
    get:
      summary: 'Retrieve a list of Campaign Pixel '
      operationId: retrieveAListOfCampaignPixel
      description: ''
      parameters:
        -
          in: query
          name: 'filter[pixelType]'
          description: 'Pixel Type'
          example: FacebookPixel
          required: false
          schema:
            type: string
            description: 'Pixel Type'
            example: FacebookPixel
            nullable: false
        -
          in: query
          name: 'filter[pixelTrackingId]'
          description: 'Pixel Tracking Id'
          example: null
          required: false
          schema:
            type: string
            description: 'Pixel Tracking Id'
            example: null
            nullable: false
        -
          in: query
          name: 'filter[createdBy]'
          description: 'ID of the user that created the Campaign Pixel.'
          example: null
          required: false
          schema:
            type: string
            description: 'ID of the user that created the Campaign Pixel.'
            example: null
            nullable: false
        -
          in: query
          name: 'filter[updatedBy]'
          description: 'ID of the user that recently the Campaign Pixel.'
          example: null
          required: false
          schema:
            type: string
            description: 'ID of the user that recently the Campaign Pixel.'
            example: null
            nullable: false
        -
          in: query
          name: 'filter[createdAt]'
          description: 'Filter by date of creation Campaign Pixel. You can filter for a specific date or before/after a certain date by prefixing with > or <'
          example: '>2025-01-01'
          required: false
          schema:
            type: string
            description: 'Filter by date of creation Campaign Pixel. You can filter for a specific date or before/after a certain date by prefixing with > or <'
            example: '>2025-01-01'
            nullable: false
        -
          in: query
          name: 'filter[updatedAt]'
          description: 'Filter by last updated date Campaign Pixel. You can filter for a specific date or before/after a certain date by prefixing with > or <'
          example: '<2025-06-01'
          required: false
          schema:
            type: string
            description: 'Filter by last updated date Campaign Pixel. You can filter for a specific date or before/after a certain date by prefixing with > or <'
            example: '<2025-06-01'
            nullable: false
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  status: error
                  message: 'Access Denied'
                properties:
                  status:
                    type: string
                    example: error
                  message:
                    type: string
                    example: 'Access Denied'
      tags:
        - Campaigns
    post:
      summary: 'Create Campaign Pixel '
      operationId: createCampaignPixel
      description: 'Create a new Campaign Pixel.'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  status: error
                  message: 'Access Denied'
                properties:
                  status:
                    type: string
                    example: error
                  message:
                    type: string
                    example: 'Access Denied'
      tags:
        - Campaigns
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                pixelType:
                  type: string
                  description: 'The Type Of Pixel'
                  example: FacebookPixel
                  nullable: false
                pixelTrackingId:
                  type: string
                  description: 'The Pixel Tracking Id'
                  example: '282987392888293'
                  nullable: false
                description:
                  type: string
                  description: 'The description of the Campaign Pixel'
                  example: null
                  nullable: false
              required:
                - pixelType
                - pixelTrackingId
    parameters:
      -
        in: path
        name: team_id
        description: 'The ID of the team.'
        example: 9ffef0a7-e8a8-4d1b-98d1-fb819a02ded0
        required: true
        schema:
          type: string
      -
        in: path
        name: campaign_id
        description: 'The ID of the campaign.'
        example: a002dac1-1665-462e-822a-46b137e657ac
        required: true
        schema:
          type: string
  '/v1/team/{team_id}/campaigns/{campaign_id}/pixels/{id}':
    get:
      summary: 'Retrieve a Campaign Pixel '
      operationId: retrieveACampaignPixel
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  status: error
                  message: 'Access Denied'
                properties:
                  status:
                    type: string
                    example: error
                  message:
                    type: string
                    example: 'Access Denied'
      tags:
        - Campaigns
    put:
      summary: 'Update Campaign Pixel '
      operationId: updateCampaignPixel
      description: 'Update an existing Campaign Pixel.'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  status: error
                  message: 'Access Denied'
                properties:
                  status:
                    type: string
                    example: error
                  message:
                    type: string
                    example: 'Access Denied'
      tags:
        - Campaigns
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                pixelType:
                  type: string
                  description: 'The Type Of Pixel'
                  example: null
                  nullable: false
                pixelTrackingId:
                  type: string
                  description: 'The Pixel Tracking Id'
                  example: null
                  nullable: false
                description:
                  type: string
                  description: 'Description of the Pixel'
                  example: null
                  nullable: false
              required:
                - pixelType
                - pixelTrackingId
    delete:
      summary: 'Delete a Campaign Pixel '
      operationId: deleteACampaignPixel
      description: 'Delete a Campaign Pixel.'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  status: success
                properties:
                  status:
                    type: string
                    example: success
      tags:
        - Campaigns
    parameters:
      -
        in: path
        name: team_id
        description: 'The ID of the team.'
        example: 9ffef0a7-e8a8-4d1b-98d1-fb819a02ded0
        required: true
        schema:
          type: string
      -
        in: path
        name: campaign_id
        description: 'The ID of the campaign.'
        example: a002dac1-1665-462e-822a-46b137e657ac
        required: true
        schema:
          type: string
      -
        in: path
        name: id
        description: 'The ID of the pixel.'
        example: 000de240-676e-467e-988e-c10067cc36e3
        required: true
        schema:
          type: string
  '/v1/team/{team_id}/campaigns/{campaign_id}/labels/attach':
    post:
      summary: 'Assign labels to a Campaign.'
      operationId: assignLabelsToACampaign
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  status: success
                properties:
                  status:
                    type: string
                    example: success
      tags:
        - Campaigns
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                ids:
                  type: array
                  description: "The uuid's of the label to assign to the Campaign"
                  example:
                    - 9e545a7c-864e-41f4-8f9a-6eeba429f35d
                  items:
                    type: string
              required:
                - ids
    parameters:
      -
        in: path
        name: team_id
        description: 'The ID of the team.'
        example: 9ffef0a7-e8a8-4d1b-98d1-fb819a02ded0
        required: true
        schema:
          type: string
      -
        in: path
        name: campaign_id
        description: 'The ID of the campaign.'
        example: a002dac1-1665-462e-822a-46b137e657ac
        required: true
        schema:
          type: string
  '/v1/team/{team_id}/campaigns/{campaign_id}/labels/detach':
    post:
      summary: 'Remove label assignment from a Campaign.'
      operationId: removeLabelAssignmentFromACampaign
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  status: success
                properties:
                  status:
                    type: string
                    example: success
      tags:
        - Campaigns
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                ids:
                  type: array
                  description: "The uuid's of the label to remove from the Campaign"
                  example:
                    - 9e545a7c-864e-41f4-8f9a-6eeba429f35d
                  items:
                    type: string
              required:
                - ids
    parameters:
      -
        in: path
        name: team_id
        description: 'The ID of the team.'
        example: 9ffef0a7-e8a8-4d1b-98d1-fb819a02ded0
        required: true
        schema:
          type: string
      -
        in: path
        name: campaign_id
        description: 'The ID of the campaign.'
        example: a002dac1-1665-462e-822a-46b137e657ac
        required: true
        schema:
          type: string
  '/v1/team/{team_id}/campaigns/{campaign_id}/labels/sync':
    post:
      summary: 'Add or remove label assignments from a Campaign in a single request.'
      operationId: addOrRemoveLabelAssignmentsFromACampaignInASingleRequest
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  status: success
                properties:
                  status:
                    type: string
                    example: success
      tags:
        - Campaigns
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                ids:
                  type: array
                  description: "The uuid's of the label to assign and or remove from the Campaign"
                  example:
                    - 9e545a7c-864e-41f4-8f9a-6eeba429f35d
                  items:
                    type: string
              required:
                - ids
    parameters:
      -
        in: path
        name: team_id
        description: 'The ID of the team.'
        example: 9ffef0a7-e8a8-4d1b-98d1-fb819a02ded0
        required: true
        schema:
          type: string
      -
        in: path
        name: campaign_id
        description: 'The ID of the campaign.'
        example: a002dac1-1665-462e-822a-46b137e657ac
        required: true
        schema:
          type: string
  '/v1/team/{team_id}/campaigns/{campaign_id}/force':
    delete:
      summary: 'Permanently delete a Campaign'
      operationId: permanentlyDeleteACampaign
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  status: success
                properties:
                  status:
                    type: string
                    example: success
      tags:
        - Campaigns
    parameters:
      -
        in: path
        name: team_id
        description: 'The ID of the team.'
        example: 9ffef0a7-e8a8-4d1b-98d1-fb819a02ded0
        required: true
        schema:
          type: string
      -
        in: path
        name: campaign_id
        description: 'The ID of the campaign.'
        example: a002dac1-1665-462e-822a-46b137e657ac
        required: true
        schema:
          type: string
  '/v1/team/{team_id}/campaigns/{campaign_id}/restore':
    post:
      summary: 'Undelete a Campaign'
      operationId: undeleteACampaign
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  status: success
                properties:
                  status:
                    type: string
                    example: success
      tags:
        - Campaigns
    parameters:
      -
        in: path
        name: team_id
        description: 'The ID of the team.'
        example: 9ffef0a7-e8a8-4d1b-98d1-fb819a02ded0
        required: true
        schema:
          type: string
      -
        in: path
        name: campaign_id
        description: 'The ID of the campaign.'
        example: a002dac1-1665-462e-822a-46b137e657ac
        required: true
        schema:
          type: string
  '/v1/team/{team_id}/campaigns/{campaign_id}/pixels/{pixel_id}/force':
    delete:
      summary: 'Permanently Delete Campaign Pixel '
      operationId: permanentlyDeleteCampaignPixel
      description: 'Permanently delete a Campaign Pixel'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  status: success
                properties:
                  status:
                    type: string
                    example: success
      tags:
        - Campaigns
    parameters:
      -
        in: path
        name: team_id
        description: 'The uuid of the team'
        example: 02965368-dc4c-4c97-96cc-5cde287569da
        required: true
        schema:
          type: string
      -
        in: path
        name: campaign_id
        description: 'The ID of the campaign.'
        example: a002dac1-1665-462e-822a-46b137e657ac
        required: true
        schema:
          type: string
      -
        in: path
        name: pixel_id
        description: 'The uuid of the Campaign Pixel'
        example: d6683156-e48b-448b-acf8-41f981dbcc6a
        required: true
        schema:
          type: string
  '/v1/team/{team_id}/utils/customer-id-encode':
    post:
      summary: 'Encode Customer Numbers'
      operationId: encodeCustomerNumbers
      description: 'This endpoint is designed to handle the encoding and sanitization of customer IDs within a specific team context. It accepts an array of customer IDs and processes each ID to generate a sanitized version and an encoded version, returning these transformations in a structured format. Up to 1000 numbers can be encoded in each request.'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  status: success
                  data:
                    -
                      customerNumber: 555-555-4567
                      sanitized: '5555554567'
                      encoded: qBpEFZ
                    -
                      customerNumber: '(555) 555-7894'
                      sanitized: '5555557894'
                      encoded: qBpeRs
                properties:
                  status:
                    type: string
                    example: success
                  data:
                    type: array
                    example:
                      -
                        customerNumber: 555-555-4567
                        sanitized: '5555554567'
                        encoded: qBpEFZ
                      -
                        customerNumber: '(555) 555-7894'
                        sanitized: '5555557894'
                        encoded: qBpeRs
                    items:
                      type: object
                      properties:
                        customerNumber:
                          type: string
                          example: 555-555-4567
                        sanitized:
                          type: string
                          example: '5555554567'
                        encoded:
                          type: string
                          example: qBpEFZ
      tags:
        - Utilities
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                customerNumbers:
                  type: array
                  description: 'string[] The customer numbers to encode. Up to 1000 numbers can be encoded in each request.'
                  example:
                    - 555-555-4567
                    - '(555) 555-7894'
                  items:
                    type: string
              required:
                - customerNumbers
    parameters:
      -
        in: path
        name: team_id
        description: 'The ID of the team.'
        example: 9ffef0a7-e8a8-4d1b-98d1-fb819a02ded0
        required: true
        schema:
          type: string
  /your-defined-custom-domain-endpoint/:
    post:
      summary: 'Prolink Click Event'
      operationId: prolinkClickEvent
      description: 'This endpoint receives click events for Prolink URLs.'
      parameters: []
      responses:
        200:
          description: 'Event received successfully.'
          content:
            application/json:
              schema:
                type: object
                example:
                  event: prolink.click
                  version: 1.0.1
                  docs: 'https://app.301.pro/developer/v1/webhooks/prolink.click'
                  clickId: afe5dbee-54a8-4662-837e-88f50b1acbc7
                  data:
                    proLink:
                      apiHash: N5nVFPJvzQuA4egfxyL6EMctYqBmXh
                      id: 9d725436-19d9-4320-b8b7-6ccf0d60f104
                      teamId: 9d71a317-0320-4d96-affc-580457cee454
                      campaignId: 012e7f75-e6f0-477f-a71b-4c2044cf3765
                      url: 'https://301.pro/meeting/abcdef'
                      destination: 'https://hello.301.pro/meetings/301pro/schedule'
                      host: 301.pro
                      deepLink: 'https://app.301.pro/teams/9d71a317-0320-4d96-affc-580457cee454/pro-links/9d725436-19d9-4320-b8b7-6ccf0d60f104/show'
                      customData:
                        hubspotCampaignId: e5d960a2-8386-4884-a021-ac84d81eacd9
                        customKey2: customValue2
                    campaign:
                      id: 012e7f75-e6f0-477f-a71b-4c2044cf3765
                      name: 'Campaign Name'
                      teamId: 9d71a317-0320-4d96-affc-580457cee454
                    click:
                      ipAddress: 68.227.226.150
                      utcDatetime: '2024-12-16T17:58:38.000Z'
                      utcEpoch: 1735689918
                      timezone: America/Phoenix
                      variant: abcdef
                      variantDecoded: '6025551234'
                      datetime: '2024-12-16T10:58:38'
                      day: Mon
                      hour: 10
                      minute: 58
                      second: 38
                      botScore: 96
                      acceptLanguage: 'en-US,en;q=0.9'
                      userAgent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/131.0.0.0 Safari/537.36 Edg/131.0.0.0'
                      latitude: '33.39810'
                      longitude: '-111.78500'
                      continent: NA
                      country: US
                      city: Mesa
                      region: Arizona
                      regionCode: AZ
                      postalCode: '85204'
                      referrerUrl: 'https://x.pro/userid/tweetId'
                      destination: 'https://hello.301.pro/meetings/301pro/schedule'
                properties:
                  event:
                    type: string
                    example: prolink.click
                    description: "The type of the event 'prolink.click'."
                  version:
                    type: string
                    example: 1.0.1
                    description: 'The version of the API for this event.'
                  docs:
                    type: string
                    example: 'https://app.301.pro/developer/v1/webhooks/prolink.click'
                    description: 'URL for documentation related to this event.'
                  clickId:
                    type: string
                    example: afe5dbee-54a8-4662-837e-88f50b1acbc7
                    description: 'Unique identifier for this click event.'
                  data:
                    type: object
                    properties:
                      proLink:
                        type: object
                        properties:
                          apiHash:
                            type: string
                            example: N5nVFPJvzQuA4egfxyL6EMctYqBmXh
                            description: 'An API hash for the Prolink.'
                          id:
                            type: string
                            example: 9d725436-19d9-4320-b8b7-6ccf0d60f104
                            description: 'ID of the Prolink in 301.pro.'
                          teamId:
                            type: string
                            example: 9d71a317-0320-4d96-affc-580457cee454
                            description: 'Team ID associated with the Prolink.'
                          campaignId:
                            type: string
                            example: 012e7f75-e6f0-477f-a71b-4c2044cf3765
                            description: 'Campaign ID associated with the Prolink, if applicable, can be null.'
                          url:
                            type: string
                            example: 'https://301.pro/meeting/abcdef'
                            description: 'The URL of the Prolink.'
                          destination:
                            type: string
                            example: 'https://hello.301.pro/meetings/301pro/schedule'
                            description: 'The original destination URL where the Prolink leads.'
                          host:
                            type: string
                            example: 301.pro
                            description: 'Hostname assigned to the Prolink.'
                          deepLink:
                            type: string
                            example: 'https://app.301.pro/teams/9d71a317-0320-4d96-affc-580457cee454/pro-links/9d725436-19d9-4320-b8b7-6ccf0d60f104/show'
                            description: 'A deep link associated with the Prolink to manage through the 301.pro application.'
                          customData:
                            type: object
                            properties:
                              hubspotCampaignId:
                                type: string
                                example: e5d960a2-8386-4884-a021-ac84d81eacd9
                              customKey2:
                                type: string
                                example: customValue2
                            description: '(nullable) - Custom Data assigned to this Pro Link. Example: {"hubspotCampaignId": "e5d960a2-8386-4884-a021-ac84d81eacd9", "customKey2": "customValue2"}'
                        description: 'Details about the Prolink that was clicked.'
                      campaign:
                        type: object
                        properties:
                          id:
                            type: string
                            example: 012e7f75-e6f0-477f-a71b-4c2044cf3765
                            description: 'Campaign Id'
                          name:
                            type: string
                            example: 'Campaign Name'
                            description: 'Campaign Name'
                          teamId:
                            type: string
                            example: 9d71a317-0320-4d96-affc-580457cee454
                            description: 'Team ID'
                        description: '( nullable ) - Associated campaign information.  '
                      click:
                        type: object
                        properties:
                          ipAddress:
                            type: string
                            example: 68.227.226.150
                            description: 'Originating IP address of the click event.'
                          utcDatetime:
                            type: string
                            example: '2024-12-16T17:58:38.000Z'
                            description: 'ISO Date in UTC when the click occurred.'
                          utcEpoch:
                            type: integer
                            example: 1735689918
                            description: 'Epoch time of the click event in UTC.'
                          timezone:
                            type: string
                            example: America/Phoenix
                            description: 'Timezone where the click event occurred.'
                          variant:
                            type: string
                            example: abcdef
                            description: 'Variant code of the Prolink.  This is path segment following the ProLink Key (https://demo.301pro.com/proLinkKey/variantCode).'
                          variantDecoded:
                            type: string
                            example: '6025551234'
                            description: 'The Decoded Variant Code value.'
                          datetime:
                            type: string
                            example: '2024-12-16T10:58:38'
                            description: 'Local date and time when the click occurred.'
                          day:
                            type: string
                            example: Mon
                            description: 'Day of the week when the click occurred.'
                          hour:
                            type: integer
                            example: 10
                            description: 'Hour of the day when the click occurred.'
                          minute:
                            type: integer
                            example: 58
                            description: 'Minute when the click occurred.'
                          second:
                            type: integer
                            example: 38
                            description: 'Second when the click occurred.'
                          botScore:
                            type: integer
                            example: 96
                            description: 'Bot detection score for the click event.'
                          acceptLanguage:
                            type: string
                            example: 'en-US,en;q=0.9'
                            description: "Language preferences sent by the client's browser."
                          userAgent:
                            type: string
                            example: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/131.0.0.0 Safari/537.36 Edg/131.0.0.0'
                            description: "User agent string of the client's browser."
                          latitude:
                            type: string
                            example: '33.39810'
                            description: 'Latitude of the click event location.'
                          longitude:
                            type: string
                            example: '-111.78500'
                            description: 'Longitude of the click event location.'
                          continent:
                            type: string
                            example: NA
                            description: 'Continent where the click event occurred.'
                          country:
                            type: string
                            example: US
                            description: 'Country where the click event occurred.'
                          city:
                            type: string
                            example: Mesa
                            description: 'City where the click event occurred.'
                          region:
                            type: string
                            example: Arizona
                            description: 'Region or state where the click event occurred.'
                          regionCode:
                            type: string
                            example: AZ
                            description: 'Region Abbreviation for the region or state which the click occurred.'
                          postalCode:
                            type: string
                            example: '85204'
                            description: 'Postal code of the location which the click occurred.'
                          referrerUrl:
                            type: string
                            example: 'https://x.pro/userid/tweetId'
                            description: 'URL of the page from which the click occurred.'
                          destination:
                            type: string
                            example: 'https://hello.301.pro/meetings/301pro/schedule'
                            description: 'The final URL to which the click was redirected.'
                        description: 'Details about the click event.'
                    description: 'Contains detailed information about the click and the Prolink.'
      tags:
        - 'Webhook Events'
      security: []
tags:
  -
    name: Teams
    description: ''
  -
    name: Team
    description: ''
  -
    name: ProLinks
    description: ''
  -
    name: Campaigns
    description: ''
  -
    name: Utilities
    description: ''
  -
    name: 'Webhook Events'
    description: 'Endpoints for handling webhook events from Prolink. Visit https://301.pro/developer/v1/webhooks for more information'
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: 'You can retrieve your token by visiting your dashboard and clicking <b>API token</b> on the User Profile Menu.'
security:
  -
    default: []
