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[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
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      id: 000de240-2e36-4621-a3fb-782db631e683
                      teamOwnerId: 000de240-355e-4814-8606-d308260927ae
                      name: Realtime
                      teamType: realtime
                      status: published
                      createdAt: '2025-03-18T22:23:28.000000Z'
                      updatedAt: '2025-03-18T22:23:37.000000Z'
                    -
                      id: 000de240-990b-4a6b-be68-b0c178b11949
                      teamOwnerId: 000de240-355e-4814-8606-d308260927ae
                      name: Business
                      teamType: business
                      status: published
                      createdAt: '2025-03-18T22:23:27.000000Z'
                      updatedAt: '2025-03-18T22:23:35.000000Z'
                    -
                      id: 000de240-e4b3-4177-946f-c78813737cb3
                      teamOwnerId: 000de240-355e-4814-8606-d308260927ae
                      name: Professional
                      teamType: professional
                      status: published
                      createdAt: '2025-03-18T22:23:25.000000Z'
                      updatedAt: '2025-03-18T22:23:34.000000Z'
                    -
                      id: 000de240-e3d4-464e-9f7a-b160235a1f05
                      teamOwnerId: 000de240-355e-4814-8606-d308260927ae
                      name: Artist
                      teamType: artist
                      status: published
                      createdAt: '2025-03-18T22:23:24.000000Z'
                      updatedAt: '2025-03-18T22:23:32.000000Z'
                    -
                      id: 000de240-04fe-40dd-8928-a94f61040035
                      teamOwnerId: 000de240-355e-4814-8606-d308260927ae
                      name: 'Business Demo'
                      teamType: business_demo
                      status: published
                      createdAt: '2025-03-18T22:23:23.000000Z'
                      updatedAt: '2025-03-18T22:23:31.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: 5
                    total: 5
                properties:
                  data:
                    type: array
                    example:
                      -
                        id: 000de240-2e36-4621-a3fb-782db631e683
                        teamOwnerId: 000de240-355e-4814-8606-d308260927ae
                        name: Realtime
                        teamType: realtime
                        status: published
                        createdAt: '2025-03-18T22:23:28.000000Z'
                        updatedAt: '2025-03-18T22:23:37.000000Z'
                      -
                        id: 000de240-990b-4a6b-be68-b0c178b11949
                        teamOwnerId: 000de240-355e-4814-8606-d308260927ae
                        name: Business
                        teamType: business
                        status: published
                        createdAt: '2025-03-18T22:23:27.000000Z'
                        updatedAt: '2025-03-18T22:23:35.000000Z'
                      -
                        id: 000de240-e4b3-4177-946f-c78813737cb3
                        teamOwnerId: 000de240-355e-4814-8606-d308260927ae
                        name: Professional
                        teamType: professional
                        status: published
                        createdAt: '2025-03-18T22:23:25.000000Z'
                        updatedAt: '2025-03-18T22:23:34.000000Z'
                      -
                        id: 000de240-e3d4-464e-9f7a-b160235a1f05
                        teamOwnerId: 000de240-355e-4814-8606-d308260927ae
                        name: Artist
                        teamType: artist
                        status: published
                        createdAt: '2025-03-18T22:23:24.000000Z'
                        updatedAt: '2025-03-18T22:23:32.000000Z'
                      -
                        id: 000de240-04fe-40dd-8928-a94f61040035
                        teamOwnerId: 000de240-355e-4814-8606-d308260927ae
                        name: 'Business Demo'
                        teamType: business_demo
                        status: published
                        createdAt: '2025-03-18T22:23:23.000000Z'
                        updatedAt: '2025-03-18T22:23:31.000000Z'
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: 000de240-2e36-4621-a3fb-782db631e683
                        teamOwnerId:
                          type: string
                          example: 000de240-355e-4814-8606-d308260927ae
                        name:
                          type: string
                          example: Realtime
                        teamType:
                          type: string
                          example: realtime
                        status:
                          type: string
                          example: published
                        createdAt:
                          type: string
                          example: '2025-03-18T22:23:28.000000Z'
                        updatedAt:
                          type: string
                          example: '2025-03-18T22:23:37.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: 5
                      total:
                        type: integer
                        example: 5
      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: 9e5489d0-51a5-4da7-9bfe-ce2d261bf556
                      title: Affiliate
                      color: '#8F564A'
                      description: Affiliate
                      createdAt: '2025-03-01T20:01:05.000000Z'
                      updatedAt: '2025-03-01T20:01:05.000000Z'
                    -
                      id: 9e5489d0-4f9a-4ca6-944b-3fb51bb4fdb8
                      title: Blog
                      color: '#5FEE02'
                      description: Blog
                      createdAt: '2025-03-01T20:01:05.000000Z'
                      updatedAt: '2025-03-01T20:01:05.000000Z'
                    -
                      id: 9e5489d0-50cf-4614-a99e-f3bf734f4493
                      title: Documentation
                      color: '#B93DA2'
                      description: Documentation
                      createdAt: '2025-03-01T20:01:05.000000Z'
                      updatedAt: '2025-03-01T20:01:05.000000Z'
                    -
                      id: 9e5489d0-5020-46d1-a3f3-32e5206f8fa0
                      title: Email
                      color: '#94454F'
                      description: Email
                      createdAt: '2025-03-01T20:01:05.000000Z'
                      updatedAt: '2025-03-01T20:01:05.000000Z'
                    -
                      id: 9e5489d0-515c-49e9-b44e-126b5766ad4f
                      title: Events
                      color: '#A7CBB7'
                      description: Events
                      createdAt: '2025-03-01T20:01:05.000000Z'
                      updatedAt: '2025-03-01T20:01:05.000000Z'
                    -
                      id: 9e5489d0-507e-460a-adc0-c557d86651d5
                      title: 'Product Feature'
                      color: '#BE94F6'
                      description: 'Product Feature'
                      createdAt: '2025-03-01T20:01:05.000000Z'
                      updatedAt: '2025-03-01T20:01:05.000000Z'
                    -
                      id: 9e5489d0-5115-4627-ab4e-c532d1a051e2
                      title: Sample
                      color: '#4D44D5'
                      description: Sample
                      createdAt: '2025-03-01T20:01:05.000000Z'
                      updatedAt: '2025-03-01T20:01:05.000000Z'
                  links:
                    first: 'https://api.301.pro/v1/team/9e5489a4-fa7c-4cf7-9a18-9a5b620e58e8/labels?filter%5Btitle%5D=%22Email%22&filter%5Bcolor%5D=%22%2300eeff%22&filter%5Bdescription%5D=%22email%22&filter%5BcreatedAt%5D=%3E2025-01-01&filter%5BupdatedAt%5D=%3E2025-01-01&sort=-createdAt%2Ctitle&page=1'
                    last: 'https://api.301.pro/v1/team/9e5489a4-fa7c-4cf7-9a18-9a5b620e58e8/labels?filter%5Btitle%5D=%22Email%22&filter%5Bcolor%5D=%22%2300eeff%22&filter%5Bdescription%5D=%22email%22&filter%5BcreatedAt%5D=%3E2025-01-01&filter%5BupdatedAt%5D=%3E2025-01-01&sort=-createdAt%2Ctitle&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/9e5489a4-fa7c-4cf7-9a18-9a5b620e58e8/labels?filter%5Btitle%5D=%22Email%22&filter%5Bcolor%5D=%22%2300eeff%22&filter%5Bdescription%5D=%22email%22&filter%5BcreatedAt%5D=%3E2025-01-01&filter%5BupdatedAt%5D=%3E2025-01-01&sort=-createdAt%2Ctitle&page=1'
                        label: '1'
                        active: true
                      -
                        url: null
                        label: 'Next &raquo;'
                        active: false
                    path: 'https://api.301.pro/v1/team/9e5489a4-fa7c-4cf7-9a18-9a5b620e58e8/labels'
                    per_page: 30
                    to: 7
                    total: 7
                properties:
                  data:
                    type: array
                    example:
                      -
                        id: 9e5489d0-51a5-4da7-9bfe-ce2d261bf556
                        title: Affiliate
                        color: '#8F564A'
                        description: Affiliate
                        createdAt: '2025-03-01T20:01:05.000000Z'
                        updatedAt: '2025-03-01T20:01:05.000000Z'
                      -
                        id: 9e5489d0-4f9a-4ca6-944b-3fb51bb4fdb8
                        title: Blog
                        color: '#5FEE02'
                        description: Blog
                        createdAt: '2025-03-01T20:01:05.000000Z'
                        updatedAt: '2025-03-01T20:01:05.000000Z'
                      -
                        id: 9e5489d0-50cf-4614-a99e-f3bf734f4493
                        title: Documentation
                        color: '#B93DA2'
                        description: Documentation
                        createdAt: '2025-03-01T20:01:05.000000Z'
                        updatedAt: '2025-03-01T20:01:05.000000Z'
                      -
                        id: 9e5489d0-5020-46d1-a3f3-32e5206f8fa0
                        title: Email
                        color: '#94454F'
                        description: Email
                        createdAt: '2025-03-01T20:01:05.000000Z'
                        updatedAt: '2025-03-01T20:01:05.000000Z'
                      -
                        id: 9e5489d0-515c-49e9-b44e-126b5766ad4f
                        title: Events
                        color: '#A7CBB7'
                        description: Events
                        createdAt: '2025-03-01T20:01:05.000000Z'
                        updatedAt: '2025-03-01T20:01:05.000000Z'
                      -
                        id: 9e5489d0-507e-460a-adc0-c557d86651d5
                        title: 'Product Feature'
                        color: '#BE94F6'
                        description: 'Product Feature'
                        createdAt: '2025-03-01T20:01:05.000000Z'
                        updatedAt: '2025-03-01T20:01:05.000000Z'
                      -
                        id: 9e5489d0-5115-4627-ab4e-c532d1a051e2
                        title: Sample
                        color: '#4D44D5'
                        description: Sample
                        createdAt: '2025-03-01T20:01:05.000000Z'
                        updatedAt: '2025-03-01T20:01:05.000000Z'
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: 9e5489d0-51a5-4da7-9bfe-ce2d261bf556
                        title:
                          type: string
                          example: Affiliate
                        color:
                          type: string
                          example: '#8F564A'
                        description:
                          type: string
                          example: Affiliate
                        createdAt:
                          type: string
                          example: '2025-03-01T20:01:05.000000Z'
                        updatedAt:
                          type: string
                          example: '2025-03-01T20:01:05.000000Z'
                  links:
                    type: object
                    properties:
                      first:
                        type: string
                        example: 'https://api.301.pro/v1/team/9e5489a4-fa7c-4cf7-9a18-9a5b620e58e8/labels?filter%5Btitle%5D=%22Email%22&filter%5Bcolor%5D=%22%2300eeff%22&filter%5Bdescription%5D=%22email%22&filter%5BcreatedAt%5D=%3E2025-01-01&filter%5BupdatedAt%5D=%3E2025-01-01&sort=-createdAt%2Ctitle&page=1'
                      last:
                        type: string
                        example: 'https://api.301.pro/v1/team/9e5489a4-fa7c-4cf7-9a18-9a5b620e58e8/labels?filter%5Btitle%5D=%22Email%22&filter%5Bcolor%5D=%22%2300eeff%22&filter%5Bdescription%5D=%22email%22&filter%5BcreatedAt%5D=%3E2025-01-01&filter%5BupdatedAt%5D=%3E2025-01-01&sort=-createdAt%2Ctitle&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/9e5489a4-fa7c-4cf7-9a18-9a5b620e58e8/labels?filter%5Btitle%5D=%22Email%22&filter%5Bcolor%5D=%22%2300eeff%22&filter%5Bdescription%5D=%22email%22&filter%5BcreatedAt%5D=%3E2025-01-01&filter%5BupdatedAt%5D=%3E2025-01-01&sort=-createdAt%2Ctitle&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/9e5489a4-fa7c-4cf7-9a18-9a5b620e58e8/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:
                type: object
                example:
                  id: 9e522ea0-7f25-4962-8af0-333e81eb6fd2
                  title: Blog
                  color: '#356237'
                  description: Blog
                  createdAt: '2025-02-28T15:54:27.000000Z'
                  updatedAt: '2025-02-28T15:54:27.000000Z'
                properties:
                  id:
                    type: string
                    example: 9e522ea0-7f25-4962-8af0-333e81eb6fd2
                  title:
                    type: string
                    example: Blog
                  color:
                    type: string
                    example: '#356237'
                  description:
                    type: string
                    example: Blog
                  createdAt:
                    type: string
                    example: '2025-02-28T15:54:27.000000Z'
                  updatedAt:
                    type: string
                    example: '2025-02-28T15:54:27.000000Z'
      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: 9e5489a4-fa7c-4cf7-9a18-9a5b620e58e8
        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:
                type: object
                example:
                  id: 9e522ea0-7f25-4962-8af0-333e81eb6fd2
                  title: Blog
                  color: '#356237'
                  description: Blog
                  createdAt: '2025-02-28T15:54:27.000000Z'
                  updatedAt: '2025-02-28T15:54:27.000000Z'
                properties:
                  id:
                    type: string
                    example: 9e522ea0-7f25-4962-8af0-333e81eb6fd2
                  title:
                    type: string
                    example: Blog
                  color:
                    type: string
                    example: '#356237'
                  description:
                    type: string
                    example: Blog
                  createdAt:
                    type: string
                    example: '2025-02-28T15:54:27.000000Z'
                  updatedAt:
                    type: string
                    example: '2025-02-28T15:54:27.000000Z'
      tags:
        - Team
    put:
      summary: 'Update a Team Label'
      operationId: updateATeamLabel
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  id: 9e522ea0-7f25-4962-8af0-333e81eb6fd2
                  title: Blog
                  color: '#356237'
                  description: Blog
                  createdAt: '2025-02-28T15:54:27.000000Z'
                  updatedAt: '2025-02-28T15:54:27.000000Z'
                properties:
                  id:
                    type: string
                    example: 9e522ea0-7f25-4962-8af0-333e81eb6fd2
                  title:
                    type: string
                    example: Blog
                  color:
                    type: string
                    example: '#356237'
                  description:
                    type: string
                    example: Blog
                  createdAt:
                    type: string
                    example: '2025-02-28T15:54:27.000000Z'
                  updatedAt:
                    type: string
                    example: '2025-02-28T15:54:27.000000Z'
      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:
                  id: 9e5c7b08-b278-4450-9bb3-2f4537518919
                  subjectType: team
                  subjectId: 9e522e02-f1c7-4c1e-ba56-bafdfa930a69
                  pixelType: FacebookPixel
                  pixelTypeDisplay: 'Facebook Pixel'
                  pixelTrackingId: '5884321354687987'
                  description: '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
                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: '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
      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: 9e5489a4-fa7c-4cf7-9a18-9a5b620e58e8
        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:
                  id: 9e5c7b08-b278-4450-9bb3-2f4537518919
                  subjectType: team
                  subjectId: 9e522e02-f1c7-4c1e-ba56-bafdfa930a69
                  pixelType: FacebookPixel
                  pixelTypeDisplay: 'Facebook Pixel'
                  pixelTrackingId: '5884321354687987'
                  description: '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
                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: '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
      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:
                  id: 9e5c7b08-b278-4450-9bb3-2f4537518919
                  subjectType: team
                  subjectId: 9e522e02-f1c7-4c1e-ba56-bafdfa930a69
                  pixelType: FacebookPixel
                  pixelTypeDisplay: 'Facebook Pixel'
                  pixelTrackingId: '5884321354687987'
                  description: '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
                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: '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
      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: 9e5489a4-fa7c-4cf7-9a18-9a5b620e58e8
        required: true
        schema:
          type: string
      -
        in: path
        name: id
        description: 'The ID of the pixel.'
        example: 9e56b73b-06ce-48fd-ab99-d740ebff34d0
        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: c1244b55-0287-402f-b9a4-6e25a1323f25
        required: true
        schema:
          type: string
      -
        in: path
        name: pixel_id
        description: 'The uuid of the Team Pixel'
        example: 65439bba-bfd2-4bd3-b9a8-144ec2948214
        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:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      id: 9e5489d2-9835-4002-9e9f-870ad16d2be6
                      teamId: 9e5489a4-fa7c-4cf7-9a18-9a5b620e58e8
                      campaignId: 9e5489d0-5268-45d5-a79a-75e09a3e9422
                      apiHash: qHn4x3rZjTQ8egXbwfumFhW72taG9P
                      urlKey: qvy2R
                      destinationUrl: 'https://whatis.301.pro/pricing'
                      domainId: 9e522dff-8918-4dd7-a763-d8e4d7c4cefa
                      domainHost: demo.301.pro
                      status: published
                      title: 'Pricing | 301Pro'
                      description: 'Explore our flexible plans and pricing options crafted to suit your specific needs. With 301 Pro, you can achieve powerful link redirection optimization at a'
                      destinationMetaName:
                        robots: 'follow, index, max-snippet:-1, max-video-preview:-1, max-image-preview:large'
                        viewport: 'width=device-width, initial-scale=1, minimum-scale=1'
                        generator: 'WordPress 6.7.2'
                        description: 'Explore our flexible plans and pricing options crafted to suit your specific needs. With 301 Pro, you can achieve powerful link redirection optimization at a'
                        'twitter:card': summary_large_image
                        'twitter:site': '@301Prof'
                        'twitter:data1': '2 minutes'
                        'twitter:image': 'https://301pro.com/wp-content/uploads/2024/12/301-Pro-.jpg'
                        'twitter:title': 'Pricing | 301Pro'
                        'twitter:label1': 'Time to read'
                        'twitter:creator': '@301Prof'
                        'twitter:description': 'Explore our flexible plans and pricing options crafted to suit your specific needs. With 301 Pro, you can achieve powerful link redirection optimization at a'
                        msapplication-TileImage: 'https://301pro.com/wp-content/uploads/2024/12/cropped-New-301-Logo-270x270.webp'
                      destinationMetaProperty:
                        'og:url': 'https://301pro.com/pricing/'
                        'og:type': article
                        'og:image': 'https://301pro.com/wp-content/uploads/2024/12/301-Pro-.jpg'
                        'og:title': 'Pricing | 301Pro'
                        'og:locale': en_US
                        'og:image:alt': Pricing
                        'og:site_name': '301 ProLink Redirection'
                        'og:image:type': image/jpeg
                        'og:description': 'Explore our flexible plans and pricing options crafted to suit your specific needs. With 301 Pro, you can achieve powerful link redirection optimization at a'
                        'og:image:width': '1024'
                        'og:image:height': '575'
                        'og:updated_time': '2025-02-18T14:08:24-07:00'
                        'og:image:secure_url': 'https://301pro.com/wp-content/uploads/2024/12/301-Pro-.jpg'
                        'article:modified_time': '2025-02-18T14:08:24-07:00'
                        'article:published_time': '2024-10-23T14:01:21-07:00'
                      clicks: 0
                      createdAt: '2025-03-01T20:01:07.000000Z'
                      updatedAt: '2025-03-01T20:01:09.000000Z'
                  links:
                    first: 'https://api.301.pro/v1/team/9e5489a4-fa7c-4cf7-9a18-9a5b620e58e8/prolinks?page=1'
                    last: 'https://api.301.pro/v1/team/9e5489a4-fa7c-4cf7-9a18-9a5b620e58e8/prolinks?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/9e5489a4-fa7c-4cf7-9a18-9a5b620e58e8/prolinks?page=1'
                        label: '1'
                        active: true
                      -
                        url: null
                        label: 'Next &raquo;'
                        active: false
                    path: 'https://api.301.pro/v1/team/9e5489a4-fa7c-4cf7-9a18-9a5b620e58e8/prolinks'
                    per_page: 15
                    to: 1
                    total: 1
                properties:
                  data:
                    type: array
                    example:
                      -
                        id: 9e5489d2-9835-4002-9e9f-870ad16d2be6
                        teamId: 9e5489a4-fa7c-4cf7-9a18-9a5b620e58e8
                        campaignId: 9e5489d0-5268-45d5-a79a-75e09a3e9422
                        apiHash: qHn4x3rZjTQ8egXbwfumFhW72taG9P
                        urlKey: qvy2R
                        destinationUrl: 'https://whatis.301.pro/pricing'
                        domainId: 9e522dff-8918-4dd7-a763-d8e4d7c4cefa
                        domainHost: demo.301.pro
                        status: published
                        title: 'Pricing | 301Pro'
                        description: 'Explore our flexible plans and pricing options crafted to suit your specific needs. With 301 Pro, you can achieve powerful link redirection optimization at a'
                        destinationMetaName:
                          robots: 'follow, index, max-snippet:-1, max-video-preview:-1, max-image-preview:large'
                          viewport: 'width=device-width, initial-scale=1, minimum-scale=1'
                          generator: 'WordPress 6.7.2'
                          description: 'Explore our flexible plans and pricing options crafted to suit your specific needs. With 301 Pro, you can achieve powerful link redirection optimization at a'
                          'twitter:card': summary_large_image
                          'twitter:site': '@301Prof'
                          'twitter:data1': '2 minutes'
                          'twitter:image': 'https://301pro.com/wp-content/uploads/2024/12/301-Pro-.jpg'
                          'twitter:title': 'Pricing | 301Pro'
                          'twitter:label1': 'Time to read'
                          'twitter:creator': '@301Prof'
                          'twitter:description': 'Explore our flexible plans and pricing options crafted to suit your specific needs. With 301 Pro, you can achieve powerful link redirection optimization at a'
                          msapplication-TileImage: 'https://301pro.com/wp-content/uploads/2024/12/cropped-New-301-Logo-270x270.webp'
                        destinationMetaProperty:
                          'og:url': 'https://301pro.com/pricing/'
                          'og:type': article
                          'og:image': 'https://301pro.com/wp-content/uploads/2024/12/301-Pro-.jpg'
                          'og:title': 'Pricing | 301Pro'
                          'og:locale': en_US
                          'og:image:alt': Pricing
                          'og:site_name': '301 ProLink Redirection'
                          'og:image:type': image/jpeg
                          'og:description': 'Explore our flexible plans and pricing options crafted to suit your specific needs. With 301 Pro, you can achieve powerful link redirection optimization at a'
                          'og:image:width': '1024'
                          'og:image:height': '575'
                          'og:updated_time': '2025-02-18T14:08:24-07:00'
                          'og:image:secure_url': 'https://301pro.com/wp-content/uploads/2024/12/301-Pro-.jpg'
                          'article:modified_time': '2025-02-18T14:08:24-07:00'
                          'article:published_time': '2024-10-23T14:01:21-07:00'
                        clicks: 0
                        createdAt: '2025-03-01T20:01:07.000000Z'
                        updatedAt: '2025-03-01T20:01:09.000000Z'
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: 9e5489d2-9835-4002-9e9f-870ad16d2be6
                        teamId:
                          type: string
                          example: 9e5489a4-fa7c-4cf7-9a18-9a5b620e58e8
                        campaignId:
                          type: string
                          example: 9e5489d0-5268-45d5-a79a-75e09a3e9422
                        apiHash:
                          type: string
                          example: qHn4x3rZjTQ8egXbwfumFhW72taG9P
                        urlKey:
                          type: string
                          example: qvy2R
                        destinationUrl:
                          type: string
                          example: 'https://whatis.301.pro/pricing'
                        domainId:
                          type: string
                          example: 9e522dff-8918-4dd7-a763-d8e4d7c4cefa
                        domainHost:
                          type: string
                          example: demo.301.pro
                        status:
                          type: string
                          example: published
                        title:
                          type: string
                          example: 'Pricing | 301Pro'
                        description:
                          type: string
                          example: 'Explore our flexible plans and pricing options crafted to suit your specific needs. With 301 Pro, you can achieve powerful link redirection optimization at a'
                        destinationMetaName:
                          type: object
                          properties:
                            robots:
                              type: string
                              example: 'follow, index, max-snippet:-1, max-video-preview:-1, max-image-preview:large'
                            viewport:
                              type: string
                              example: 'width=device-width, initial-scale=1, minimum-scale=1'
                            generator:
                              type: string
                              example: 'WordPress 6.7.2'
                            description:
                              type: string
                              example: 'Explore our flexible plans and pricing options crafted to suit your specific needs. With 301 Pro, you can achieve powerful link redirection optimization at a'
                            'twitter:card':
                              type: string
                              example: summary_large_image
                            'twitter:site':
                              type: string
                              example: '@301Prof'
                            'twitter:data1':
                              type: string
                              example: '2 minutes'
                            'twitter:image':
                              type: string
                              example: 'https://301pro.com/wp-content/uploads/2024/12/301-Pro-.jpg'
                            'twitter:title':
                              type: string
                              example: 'Pricing | 301Pro'
                            'twitter:label1':
                              type: string
                              example: 'Time to read'
                            'twitter:creator':
                              type: string
                              example: '@301Prof'
                            'twitter:description':
                              type: string
                              example: 'Explore our flexible plans and pricing options crafted to suit your specific needs. With 301 Pro, you can achieve powerful link redirection optimization at a'
                            msapplication-TileImage:
                              type: string
                              example: 'https://301pro.com/wp-content/uploads/2024/12/cropped-New-301-Logo-270x270.webp'
                        destinationMetaProperty:
                          type: object
                          properties:
                            'og:url':
                              type: string
                              example: 'https://301pro.com/pricing/'
                            'og:type':
                              type: string
                              example: article
                            'og:image':
                              type: string
                              example: 'https://301pro.com/wp-content/uploads/2024/12/301-Pro-.jpg'
                            'og:title':
                              type: string
                              example: 'Pricing | 301Pro'
                            'og:locale':
                              type: string
                              example: en_US
                            'og:image:alt':
                              type: string
                              example: Pricing
                            'og:site_name':
                              type: string
                              example: '301 ProLink Redirection'
                            'og:image:type':
                              type: string
                              example: image/jpeg
                            'og:description':
                              type: string
                              example: 'Explore our flexible plans and pricing options crafted to suit your specific needs. With 301 Pro, you can achieve powerful link redirection optimization at a'
                            'og:image:width':
                              type: string
                              example: '1024'
                            'og:image:height':
                              type: string
                              example: '575'
                            'og:updated_time':
                              type: string
                              example: '2025-02-18T14:08:24-07:00'
                            'og:image:secure_url':
                              type: string
                              example: 'https://301pro.com/wp-content/uploads/2024/12/301-Pro-.jpg'
                            'article:modified_time':
                              type: string
                              example: '2025-02-18T14:08:24-07:00'
                            'article:published_time':
                              type: string
                              example: '2024-10-23T14:01:21-07:00'
                        clicks:
                          type: integer
                          example: 0
                        createdAt:
                          type: string
                          example: '2025-03-01T20:01:07.000000Z'
                        updatedAt:
                          type: string
                          example: '2025-03-01T20:01:09.000000Z'
                  links:
                    type: object
                    properties:
                      first:
                        type: string
                        example: 'https://api.301.pro/v1/team/9e5489a4-fa7c-4cf7-9a18-9a5b620e58e8/prolinks?page=1'
                      last:
                        type: string
                        example: 'https://api.301.pro/v1/team/9e5489a4-fa7c-4cf7-9a18-9a5b620e58e8/prolinks?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/9e5489a4-fa7c-4cf7-9a18-9a5b620e58e8/prolinks?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/9e5489a4-fa7c-4cf7-9a18-9a5b620e58e8/prolinks'
                      per_page:
                        type: integer
                        example: 15
                      to:
                        type: integer
                        example: 1
                      total:
                        type: integer
                        example: 1
      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:
                type: object
                example:
                  id: 9e549072-952d-4c50-befa-90d9dc7167c9
                  teamId: 9e522e02-f1c7-4c1e-ba56-bafdfa930a69
                  campaignId: 9e523575-816f-4c80-8a8e-8884008befaf
                  apiHash: 4JjvFcN2MtC7D6TBx5yfLReprmaPQZ
                  urlKey: XBujY
                  destinationUrl: 'https://yahoo.com/sports/'
                  domainId: 9e522dff-8918-4dd7-a763-d8e4d7c4cefa
                  domainHost: demo.301.pro
                  status: published
                  title: 'Yahoo Sports: News, Scores, Video, Fantasy Games, Schedules & More - Yahoo Sports'
                  description: 'Sports News, Scores, Fantasy Games'
                  destinationMetaName:
                    keywords: ', '
                    viewport: 'width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no'
                    description: 'Sports News, Scores, Fantasy Games'
                    theme-color: '#400090'
                    'twitter:card': summary
                    msvalidate.01: A9862C0E6E1BE95BCE0BF3D0298FD58B
                    'twitter:title': 'Yahoo Sports: News, Scores, Video, Fantasy Games, Schedules & More'
                    apple-itunes-app: 'app-id=286058814,app-argument=ysportacular://,affiliate-data=ct=syc-web-smartbanner'
                    application-name: 'Yahoo Sports: News, Scores, Video, Fantasy Games, Schedules & More - Yahoo Sports'
                    'twitter:app:country': US
                    'twitter:description': 'Sports News, Scores, Fantasy Games'
                    'twitter:app:id:iphone': '286058814'
                    'oath:guce:consent-host': guce.yahoo.com
                    'twitter:app:url:iphone': 'ysportacular://'
                    msapplication-TileColor: '#6e329d'
                    msapplication-TileImage: 'https://s.yimg.com/cv/apiv2/default/icons/sports-144.png'
                    'twitter:app:name:iphone': 'Yahoo Sports'
                    google-site-verification: mTW0FtAbvsS0jRQoufwNkstxfraQV42XEm8bjebMtaI
                    'twitter:app:id:googleplay': com.yahoo.mobile.client.android.sportacular
                    'twitter:app:url:googleplay': 'https://play.google.com/store/apps/details?id=com.yahoo.mobile.client.android.sportacular'
                    'twitter:app:name:googleplay': 'Yahoo Sports'
                  destinationMetaProperty:
                    'og:type': website
                    'fb:pages': '37510781596, 115396848484203, 119530628062118, 116456261706731, 1516980071665393, 110394988999413, 112156825484904, 228108177528276, 126435880711'
                    'og:image': 'https://s.yimg.com/it/api/res/1.2/Nm.Q9ktBFq1bB8joIv0bCw--~A/YXBwaWQ9eW5ld3M7dz0xMjAwO2g9NjMwO3E9MTAw/https://s.yimg.com/cv/apiv2/social/images/yahoo_default_logo.png'
                    'og:title': 'Yahoo Sports: News, Scores, Video, Fantasy Games, Schedules & More'
                    'fb:app_id': '90376669494'
                    'al:ios:url': 'ysportacular://'
                    'al:web:url': 'https://sports.yahoo.com/'
                    'og:site_name': 'Yahoo Sports'
                    'twitter:site': '@YahooSports'
                    'al:android:url': 'ysportacular://'
                    'og:description': 'Sports News, Scores, Fantasy Games'
                    'og:image:width': '630'
                    'al:ios:app_name': 'Yahoo Sports'
                    'og:image:height': '1200'
                    'al:android:package': com.yahoo.mobile.client.android.sportacular
                    'al:android:app_name': 'Yahoo Sports'
                    'al:ios:app_store_id': '286058814'
                  clicks: 0
                  createdAt: '2025-03-01T20:19:38.000000Z'
                  updatedAt: '2025-03-01T20:19:42.000000Z'
                properties:
                  id:
                    type: string
                    example: 9e549072-952d-4c50-befa-90d9dc7167c9
                  teamId:
                    type: string
                    example: 9e522e02-f1c7-4c1e-ba56-bafdfa930a69
                  campaignId:
                    type: string
                    example: 9e523575-816f-4c80-8a8e-8884008befaf
                  apiHash:
                    type: string
                    example: 4JjvFcN2MtC7D6TBx5yfLReprmaPQZ
                  urlKey:
                    type: string
                    example: XBujY
                  destinationUrl:
                    type: string
                    example: 'https://yahoo.com/sports/'
                  domainId:
                    type: string
                    example: 9e522dff-8918-4dd7-a763-d8e4d7c4cefa
                  domainHost:
                    type: string
                    example: demo.301.pro
                  status:
                    type: string
                    example: published
                  title:
                    type: string
                    example: 'Yahoo Sports: News, Scores, Video, Fantasy Games, Schedules & More - Yahoo Sports'
                  description:
                    type: string
                    example: 'Sports News, Scores, Fantasy Games'
                  destinationMetaName:
                    type: object
                    properties:
                      keywords:
                        type: string
                        example: ', '
                      viewport:
                        type: string
                        example: 'width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no'
                      description:
                        type: string
                        example: 'Sports News, Scores, Fantasy Games'
                      theme-color:
                        type: string
                        example: '#400090'
                      'twitter:card':
                        type: string
                        example: summary
                      msvalidate.01:
                        type: string
                        example: A9862C0E6E1BE95BCE0BF3D0298FD58B
                      'twitter:title':
                        type: string
                        example: 'Yahoo Sports: News, Scores, Video, Fantasy Games, Schedules & More'
                      apple-itunes-app:
                        type: string
                        example: 'app-id=286058814,app-argument=ysportacular://,affiliate-data=ct=syc-web-smartbanner'
                      application-name:
                        type: string
                        example: 'Yahoo Sports: News, Scores, Video, Fantasy Games, Schedules & More - Yahoo Sports'
                      'twitter:app:country':
                        type: string
                        example: US
                      'twitter:description':
                        type: string
                        example: 'Sports News, Scores, Fantasy Games'
                      'twitter:app:id:iphone':
                        type: string
                        example: '286058814'
                      'oath:guce:consent-host':
                        type: string
                        example: guce.yahoo.com
                      'twitter:app:url:iphone':
                        type: string
                        example: 'ysportacular://'
                      msapplication-TileColor:
                        type: string
                        example: '#6e329d'
                      msapplication-TileImage:
                        type: string
                        example: 'https://s.yimg.com/cv/apiv2/default/icons/sports-144.png'
                      'twitter:app:name:iphone':
                        type: string
                        example: 'Yahoo Sports'
                      google-site-verification:
                        type: string
                        example: mTW0FtAbvsS0jRQoufwNkstxfraQV42XEm8bjebMtaI
                      'twitter:app:id:googleplay':
                        type: string
                        example: com.yahoo.mobile.client.android.sportacular
                      'twitter:app:url:googleplay':
                        type: string
                        example: 'https://play.google.com/store/apps/details?id=com.yahoo.mobile.client.android.sportacular'
                      'twitter:app:name:googleplay':
                        type: string
                        example: 'Yahoo Sports'
                  destinationMetaProperty:
                    type: object
                    properties:
                      'og:type':
                        type: string
                        example: website
                      'fb:pages':
                        type: string
                        example: '37510781596, 115396848484203, 119530628062118, 116456261706731, 1516980071665393, 110394988999413, 112156825484904, 228108177528276, 126435880711'
                      'og:image':
                        type: string
                        example: 'https://s.yimg.com/it/api/res/1.2/Nm.Q9ktBFq1bB8joIv0bCw--~A/YXBwaWQ9eW5ld3M7dz0xMjAwO2g9NjMwO3E9MTAw/https://s.yimg.com/cv/apiv2/social/images/yahoo_default_logo.png'
                      'og:title':
                        type: string
                        example: 'Yahoo Sports: News, Scores, Video, Fantasy Games, Schedules & More'
                      'fb:app_id':
                        type: string
                        example: '90376669494'
                      'al:ios:url':
                        type: string
                        example: 'ysportacular://'
                      'al:web:url':
                        type: string
                        example: 'https://sports.yahoo.com/'
                      'og:site_name':
                        type: string
                        example: 'Yahoo Sports'
                      'twitter:site':
                        type: string
                        example: '@YahooSports'
                      'al:android:url':
                        type: string
                        example: 'ysportacular://'
                      'og:description':
                        type: string
                        example: 'Sports News, Scores, Fantasy Games'
                      'og:image:width':
                        type: string
                        example: '630'
                      'al:ios:app_name':
                        type: string
                        example: 'Yahoo Sports'
                      'og:image:height':
                        type: string
                        example: '1200'
                      'al:android:package':
                        type: string
                        example: com.yahoo.mobile.client.android.sportacular
                      'al:android:app_name':
                        type: string
                        example: 'Yahoo Sports'
                      'al:ios:app_store_id':
                        type: string
                        example: '286058814'
                  clicks:
                    type: integer
                    example: 0
                  createdAt:
                    type: string
                    example: '2025-03-01T20:19:38.000000Z'
                  updatedAt:
                    type: string
                    example: '2025-03-01T20:19:42.000000Z'
      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
              required:
                - domain
                - destinationUrl
    parameters:
      -
        in: path
        name: team_id
        description: 'The ID of the team.'
        example: 9e5489a4-fa7c-4cf7-9a18-9a5b620e58e8
        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:
                type: object
                example:
                  id: 9e549072-952d-4c50-befa-90d9dc7167c9
                  teamId: 9e522e02-f1c7-4c1e-ba56-bafdfa930a69
                  campaignId: 9e523575-816f-4c80-8a8e-8884008befaf
                  apiHash: 4JjvFcN2MtC7D6TBx5yfLReprmaPQZ
                  urlKey: XBujY
                  destinationUrl: 'https://yahoo.com/sports/'
                  domainId: 9e522dff-8918-4dd7-a763-d8e4d7c4cefa
                  domainHost: demo.301.pro
                  status: published
                  title: 'Yahoo Sports: News, Scores, Video, Fantasy Games, Schedules & More - Yahoo Sports'
                  description: 'Sports News, Scores, Fantasy Games'
                  destinationMetaName:
                    keywords: ', '
                    viewport: 'width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no'
                    description: 'Sports News, Scores, Fantasy Games'
                    theme-color: '#400090'
                    'twitter:card': summary
                    msvalidate.01: A9862C0E6E1BE95BCE0BF3D0298FD58B
                    'twitter:title': 'Yahoo Sports: News, Scores, Video, Fantasy Games, Schedules & More'
                    apple-itunes-app: 'app-id=286058814,app-argument=ysportacular://,affiliate-data=ct=syc-web-smartbanner'
                    application-name: 'Yahoo Sports: News, Scores, Video, Fantasy Games, Schedules & More - Yahoo Sports'
                    'twitter:app:country': US
                    'twitter:description': 'Sports News, Scores, Fantasy Games'
                    'twitter:app:id:iphone': '286058814'
                    'oath:guce:consent-host': guce.yahoo.com
                    'twitter:app:url:iphone': 'ysportacular://'
                    msapplication-TileColor: '#6e329d'
                    msapplication-TileImage: 'https://s.yimg.com/cv/apiv2/default/icons/sports-144.png'
                    'twitter:app:name:iphone': 'Yahoo Sports'
                    google-site-verification: mTW0FtAbvsS0jRQoufwNkstxfraQV42XEm8bjebMtaI
                    'twitter:app:id:googleplay': com.yahoo.mobile.client.android.sportacular
                    'twitter:app:url:googleplay': 'https://play.google.com/store/apps/details?id=com.yahoo.mobile.client.android.sportacular'
                    'twitter:app:name:googleplay': 'Yahoo Sports'
                  destinationMetaProperty:
                    'og:type': website
                    'fb:pages': '37510781596, 115396848484203, 119530628062118, 116456261706731, 1516980071665393, 110394988999413, 112156825484904, 228108177528276, 126435880711'
                    'og:image': 'https://s.yimg.com/it/api/res/1.2/Nm.Q9ktBFq1bB8joIv0bCw--~A/YXBwaWQ9eW5ld3M7dz0xMjAwO2g9NjMwO3E9MTAw/https://s.yimg.com/cv/apiv2/social/images/yahoo_default_logo.png'
                    'og:title': 'Yahoo Sports: News, Scores, Video, Fantasy Games, Schedules & More'
                    'fb:app_id': '90376669494'
                    'al:ios:url': 'ysportacular://'
                    'al:web:url': 'https://sports.yahoo.com/'
                    'og:site_name': 'Yahoo Sports'
                    'twitter:site': '@YahooSports'
                    'al:android:url': 'ysportacular://'
                    'og:description': 'Sports News, Scores, Fantasy Games'
                    'og:image:width': '630'
                    'al:ios:app_name': 'Yahoo Sports'
                    'og:image:height': '1200'
                    'al:android:package': com.yahoo.mobile.client.android.sportacular
                    'al:android:app_name': 'Yahoo Sports'
                    'al:ios:app_store_id': '286058814'
                  clicks: 0
                  createdAt: '2025-03-01T20:19:38.000000Z'
                  updatedAt: '2025-03-01T20:19:42.000000Z'
                properties:
                  id:
                    type: string
                    example: 9e549072-952d-4c50-befa-90d9dc7167c9
                  teamId:
                    type: string
                    example: 9e522e02-f1c7-4c1e-ba56-bafdfa930a69
                  campaignId:
                    type: string
                    example: 9e523575-816f-4c80-8a8e-8884008befaf
                  apiHash:
                    type: string
                    example: 4JjvFcN2MtC7D6TBx5yfLReprmaPQZ
                  urlKey:
                    type: string
                    example: XBujY
                  destinationUrl:
                    type: string
                    example: 'https://yahoo.com/sports/'
                  domainId:
                    type: string
                    example: 9e522dff-8918-4dd7-a763-d8e4d7c4cefa
                  domainHost:
                    type: string
                    example: demo.301.pro
                  status:
                    type: string
                    example: published
                  title:
                    type: string
                    example: 'Yahoo Sports: News, Scores, Video, Fantasy Games, Schedules & More - Yahoo Sports'
                  description:
                    type: string
                    example: 'Sports News, Scores, Fantasy Games'
                  destinationMetaName:
                    type: object
                    properties:
                      keywords:
                        type: string
                        example: ', '
                      viewport:
                        type: string
                        example: 'width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no'
                      description:
                        type: string
                        example: 'Sports News, Scores, Fantasy Games'
                      theme-color:
                        type: string
                        example: '#400090'
                      'twitter:card':
                        type: string
                        example: summary
                      msvalidate.01:
                        type: string
                        example: A9862C0E6E1BE95BCE0BF3D0298FD58B
                      'twitter:title':
                        type: string
                        example: 'Yahoo Sports: News, Scores, Video, Fantasy Games, Schedules & More'
                      apple-itunes-app:
                        type: string
                        example: 'app-id=286058814,app-argument=ysportacular://,affiliate-data=ct=syc-web-smartbanner'
                      application-name:
                        type: string
                        example: 'Yahoo Sports: News, Scores, Video, Fantasy Games, Schedules & More - Yahoo Sports'
                      'twitter:app:country':
                        type: string
                        example: US
                      'twitter:description':
                        type: string
                        example: 'Sports News, Scores, Fantasy Games'
                      'twitter:app:id:iphone':
                        type: string
                        example: '286058814'
                      'oath:guce:consent-host':
                        type: string
                        example: guce.yahoo.com
                      'twitter:app:url:iphone':
                        type: string
                        example: 'ysportacular://'
                      msapplication-TileColor:
                        type: string
                        example: '#6e329d'
                      msapplication-TileImage:
                        type: string
                        example: 'https://s.yimg.com/cv/apiv2/default/icons/sports-144.png'
                      'twitter:app:name:iphone':
                        type: string
                        example: 'Yahoo Sports'
                      google-site-verification:
                        type: string
                        example: mTW0FtAbvsS0jRQoufwNkstxfraQV42XEm8bjebMtaI
                      'twitter:app:id:googleplay':
                        type: string
                        example: com.yahoo.mobile.client.android.sportacular
                      'twitter:app:url:googleplay':
                        type: string
                        example: 'https://play.google.com/store/apps/details?id=com.yahoo.mobile.client.android.sportacular'
                      'twitter:app:name:googleplay':
                        type: string
                        example: 'Yahoo Sports'
                  destinationMetaProperty:
                    type: object
                    properties:
                      'og:type':
                        type: string
                        example: website
                      'fb:pages':
                        type: string
                        example: '37510781596, 115396848484203, 119530628062118, 116456261706731, 1516980071665393, 110394988999413, 112156825484904, 228108177528276, 126435880711'
                      'og:image':
                        type: string
                        example: 'https://s.yimg.com/it/api/res/1.2/Nm.Q9ktBFq1bB8joIv0bCw--~A/YXBwaWQ9eW5ld3M7dz0xMjAwO2g9NjMwO3E9MTAw/https://s.yimg.com/cv/apiv2/social/images/yahoo_default_logo.png'
                      'og:title':
                        type: string
                        example: 'Yahoo Sports: News, Scores, Video, Fantasy Games, Schedules & More'
                      'fb:app_id':
                        type: string
                        example: '90376669494'
                      'al:ios:url':
                        type: string
                        example: 'ysportacular://'
                      'al:web:url':
                        type: string
                        example: 'https://sports.yahoo.com/'
                      'og:site_name':
                        type: string
                        example: 'Yahoo Sports'
                      'twitter:site':
                        type: string
                        example: '@YahooSports'
                      'al:android:url':
                        type: string
                        example: 'ysportacular://'
                      'og:description':
                        type: string
                        example: 'Sports News, Scores, Fantasy Games'
                      'og:image:width':
                        type: string
                        example: '630'
                      'al:ios:app_name':
                        type: string
                        example: 'Yahoo Sports'
                      'og:image:height':
                        type: string
                        example: '1200'
                      'al:android:package':
                        type: string
                        example: com.yahoo.mobile.client.android.sportacular
                      'al:android:app_name':
                        type: string
                        example: 'Yahoo Sports'
                      'al:ios:app_store_id':
                        type: string
                        example: '286058814'
                  clicks:
                    type: integer
                    example: 0
                  createdAt:
                    type: string
                    example: '2025-03-01T20:19:38.000000Z'
                  updatedAt:
                    type: string
                    example: '2025-03-01T20:19:42.000000Z'
      tags:
        - ProLinks
    put:
      summary: 'Update a ProLink'
      operationId: updateAProLink
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  id: 9e549072-952d-4c50-befa-90d9dc7167c9
                  teamId: 9e522e02-f1c7-4c1e-ba56-bafdfa930a69
                  campaignId: 9e523575-816f-4c80-8a8e-8884008befaf
                  apiHash: 4JjvFcN2MtC7D6TBx5yfLReprmaPQZ
                  urlKey: XBujY
                  destinationUrl: 'https://yahoo.com/sports/'
                  domainId: 9e522dff-8918-4dd7-a763-d8e4d7c4cefa
                  domainHost: demo.301.pro
                  status: published
                  title: 'Yahoo Sports: News, Scores, Video, Fantasy Games, Schedules & More - Yahoo Sports'
                  description: 'Sports News, Scores, Fantasy Games'
                  destinationMetaName:
                    keywords: ', '
                    viewport: 'width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no'
                    description: 'Sports News, Scores, Fantasy Games'
                    theme-color: '#400090'
                    'twitter:card': summary
                    msvalidate.01: A9862C0E6E1BE95BCE0BF3D0298FD58B
                    'twitter:title': 'Yahoo Sports: News, Scores, Video, Fantasy Games, Schedules & More'
                    apple-itunes-app: 'app-id=286058814,app-argument=ysportacular://,affiliate-data=ct=syc-web-smartbanner'
                    application-name: 'Yahoo Sports: News, Scores, Video, Fantasy Games, Schedules & More - Yahoo Sports'
                    'twitter:app:country': US
                    'twitter:description': 'Sports News, Scores, Fantasy Games'
                    'twitter:app:id:iphone': '286058814'
                    'oath:guce:consent-host': guce.yahoo.com
                    'twitter:app:url:iphone': 'ysportacular://'
                    msapplication-TileColor: '#6e329d'
                    msapplication-TileImage: 'https://s.yimg.com/cv/apiv2/default/icons/sports-144.png'
                    'twitter:app:name:iphone': 'Yahoo Sports'
                    google-site-verification: mTW0FtAbvsS0jRQoufwNkstxfraQV42XEm8bjebMtaI
                    'twitter:app:id:googleplay': com.yahoo.mobile.client.android.sportacular
                    'twitter:app:url:googleplay': 'https://play.google.com/store/apps/details?id=com.yahoo.mobile.client.android.sportacular'
                    'twitter:app:name:googleplay': 'Yahoo Sports'
                  destinationMetaProperty:
                    'og:type': website
                    'fb:pages': '37510781596, 115396848484203, 119530628062118, 116456261706731, 1516980071665393, 110394988999413, 112156825484904, 228108177528276, 126435880711'
                    'og:image': 'https://s.yimg.com/it/api/res/1.2/Nm.Q9ktBFq1bB8joIv0bCw--~A/YXBwaWQ9eW5ld3M7dz0xMjAwO2g9NjMwO3E9MTAw/https://s.yimg.com/cv/apiv2/social/images/yahoo_default_logo.png'
                    'og:title': 'Yahoo Sports: News, Scores, Video, Fantasy Games, Schedules & More'
                    'fb:app_id': '90376669494'
                    'al:ios:url': 'ysportacular://'
                    'al:web:url': 'https://sports.yahoo.com/'
                    'og:site_name': 'Yahoo Sports'
                    'twitter:site': '@YahooSports'
                    'al:android:url': 'ysportacular://'
                    'og:description': 'Sports News, Scores, Fantasy Games'
                    'og:image:width': '630'
                    'al:ios:app_name': 'Yahoo Sports'
                    'og:image:height': '1200'
                    'al:android:package': com.yahoo.mobile.client.android.sportacular
                    'al:android:app_name': 'Yahoo Sports'
                    'al:ios:app_store_id': '286058814'
                  clicks: 0
                  createdAt: '2025-03-01T20:19:38.000000Z'
                  updatedAt: '2025-03-01T20:19:42.000000Z'
                properties:
                  id:
                    type: string
                    example: 9e549072-952d-4c50-befa-90d9dc7167c9
                  teamId:
                    type: string
                    example: 9e522e02-f1c7-4c1e-ba56-bafdfa930a69
                  campaignId:
                    type: string
                    example: 9e523575-816f-4c80-8a8e-8884008befaf
                  apiHash:
                    type: string
                    example: 4JjvFcN2MtC7D6TBx5yfLReprmaPQZ
                  urlKey:
                    type: string
                    example: XBujY
                  destinationUrl:
                    type: string
                    example: 'https://yahoo.com/sports/'
                  domainId:
                    type: string
                    example: 9e522dff-8918-4dd7-a763-d8e4d7c4cefa
                  domainHost:
                    type: string
                    example: demo.301.pro
                  status:
                    type: string
                    example: published
                  title:
                    type: string
                    example: 'Yahoo Sports: News, Scores, Video, Fantasy Games, Schedules & More - Yahoo Sports'
                  description:
                    type: string
                    example: 'Sports News, Scores, Fantasy Games'
                  destinationMetaName:
                    type: object
                    properties:
                      keywords:
                        type: string
                        example: ', '
                      viewport:
                        type: string
                        example: 'width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no'
                      description:
                        type: string
                        example: 'Sports News, Scores, Fantasy Games'
                      theme-color:
                        type: string
                        example: '#400090'
                      'twitter:card':
                        type: string
                        example: summary
                      msvalidate.01:
                        type: string
                        example: A9862C0E6E1BE95BCE0BF3D0298FD58B
                      'twitter:title':
                        type: string
                        example: 'Yahoo Sports: News, Scores, Video, Fantasy Games, Schedules & More'
                      apple-itunes-app:
                        type: string
                        example: 'app-id=286058814,app-argument=ysportacular://,affiliate-data=ct=syc-web-smartbanner'
                      application-name:
                        type: string
                        example: 'Yahoo Sports: News, Scores, Video, Fantasy Games, Schedules & More - Yahoo Sports'
                      'twitter:app:country':
                        type: string
                        example: US
                      'twitter:description':
                        type: string
                        example: 'Sports News, Scores, Fantasy Games'
                      'twitter:app:id:iphone':
                        type: string
                        example: '286058814'
                      'oath:guce:consent-host':
                        type: string
                        example: guce.yahoo.com
                      'twitter:app:url:iphone':
                        type: string
                        example: 'ysportacular://'
                      msapplication-TileColor:
                        type: string
                        example: '#6e329d'
                      msapplication-TileImage:
                        type: string
                        example: 'https://s.yimg.com/cv/apiv2/default/icons/sports-144.png'
                      'twitter:app:name:iphone':
                        type: string
                        example: 'Yahoo Sports'
                      google-site-verification:
                        type: string
                        example: mTW0FtAbvsS0jRQoufwNkstxfraQV42XEm8bjebMtaI
                      'twitter:app:id:googleplay':
                        type: string
                        example: com.yahoo.mobile.client.android.sportacular
                      'twitter:app:url:googleplay':
                        type: string
                        example: 'https://play.google.com/store/apps/details?id=com.yahoo.mobile.client.android.sportacular'
                      'twitter:app:name:googleplay':
                        type: string
                        example: 'Yahoo Sports'
                  destinationMetaProperty:
                    type: object
                    properties:
                      'og:type':
                        type: string
                        example: website
                      'fb:pages':
                        type: string
                        example: '37510781596, 115396848484203, 119530628062118, 116456261706731, 1516980071665393, 110394988999413, 112156825484904, 228108177528276, 126435880711'
                      'og:image':
                        type: string
                        example: 'https://s.yimg.com/it/api/res/1.2/Nm.Q9ktBFq1bB8joIv0bCw--~A/YXBwaWQ9eW5ld3M7dz0xMjAwO2g9NjMwO3E9MTAw/https://s.yimg.com/cv/apiv2/social/images/yahoo_default_logo.png'
                      'og:title':
                        type: string
                        example: 'Yahoo Sports: News, Scores, Video, Fantasy Games, Schedules & More'
                      'fb:app_id':
                        type: string
                        example: '90376669494'
                      'al:ios:url':
                        type: string
                        example: 'ysportacular://'
                      'al:web:url':
                        type: string
                        example: 'https://sports.yahoo.com/'
                      'og:site_name':
                        type: string
                        example: 'Yahoo Sports'
                      'twitter:site':
                        type: string
                        example: '@YahooSports'
                      'al:android:url':
                        type: string
                        example: 'ysportacular://'
                      'og:description':
                        type: string
                        example: 'Sports News, Scores, Fantasy Games'
                      'og:image:width':
                        type: string
                        example: '630'
                      'al:ios:app_name':
                        type: string
                        example: 'Yahoo Sports'
                      'og:image:height':
                        type: string
                        example: '1200'
                      'al:android:package':
                        type: string
                        example: com.yahoo.mobile.client.android.sportacular
                      'al:android:app_name':
                        type: string
                        example: 'Yahoo Sports'
                      'al:ios:app_store_id':
                        type: string
                        example: '286058814'
                  clicks:
                    type: integer
                    example: 0
                  createdAt:
                    type: string
                    example: '2025-03-01T20:19:38.000000Z'
                  updatedAt:
                    type: string
                    example: '2025-03-01T20:19:42.000000Z'
      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: {  }
              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: 9e5489a4-fa7c-4cf7-9a18-9a5b620e58e8
        required: true
        schema:
          type: string
      -
        in: path
        name: id
        description: 'The ID of the prolink.'
        example: 9e549072-952d-4c50-befa-90d9dc7167c9
        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: 9e5489a4-fa7c-4cf7-9a18-9a5b620e58e8
        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: 9e5489a4-fa7c-4cf7-9a18-9a5b620e58e8
        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: 000de240-990b-4a6b-be68-b0c178b11949
        required: true
        schema:
          type: string
      -
        in: path
        name: prolink_id
        description: 'The uuid of the ProLink'
        example: a84fd40f-7e0c-4283-af84-069fd9c62b6b
        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: 000de240-990b-4a6b-be68-b0c178b11949
        required: true
        schema:
          type: string
      -
        in: path
        name: prolink_id
        description: 'The uuid of the ProLink'
        example: db5e8819-0360-43ca-8743-c72c90f048b4
        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: 000de240-990b-4a6b-be68-b0c178b11949
        required: true
        schema:
          type: string
      -
        in: path
        name: prolink_id
        description: 'The uuid of the ProLink'
        example: be372a5b-a793-4d7d-b1f0-94d8fc4c3325
        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: 9e5489a4-fa7c-4cf7-9a18-9a5b620e58e8
        required: true
        schema:
          type: string
      -
        in: path
        name: prolink_id
        description: 'The ID of the prolink.'
        example: 9e549072-952d-4c50-befa-90d9dc7167c9
        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: 9e5489a4-fa7c-4cf7-9a18-9a5b620e58e8
        required: true
        schema:
          type: string
      -
        in: path
        name: prolink_id
        description: 'The ID of the prolink.'
        example: 9e549072-952d-4c50-befa-90d9dc7167c9
        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:
                  data:
                    -
                      id: 9e5489d0-5268-45d5-a79a-75e09a3e9422
                      teamId: 9e5489a4-fa7c-4cf7-9a18-9a5b620e58e8
                      name: 'CDE - Click Data Enrichment'
                      description: 'Add CDE to each link'
                      status: published
                      createdAt: '2025-03-01T20:01:05.000000Z'
                      updatedAt: '2025-03-01T20:01:07.000000Z'
                  links:
                    first: 'https://api.301.pro/v1/team/9e5489a4-fa7c-4cf7-9a18-9a5b620e58e8/campaigns?page=1'
                    last: 'https://api.301.pro/v1/team/9e5489a4-fa7c-4cf7-9a18-9a5b620e58e8/campaigns?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/9e5489a4-fa7c-4cf7-9a18-9a5b620e58e8/campaigns?page=1'
                        label: '1'
                        active: true
                      -
                        url: null
                        label: 'Next &raquo;'
                        active: false
                    path: 'https://api.301.pro/v1/team/9e5489a4-fa7c-4cf7-9a18-9a5b620e58e8/campaigns'
                    per_page: 15
                    to: 1
                    total: 1
                properties:
                  data:
                    type: array
                    example:
                      -
                        id: 9e5489d0-5268-45d5-a79a-75e09a3e9422
                        teamId: 9e5489a4-fa7c-4cf7-9a18-9a5b620e58e8
                        name: 'CDE - Click Data Enrichment'
                        description: 'Add CDE to each link'
                        status: published
                        createdAt: '2025-03-01T20:01:05.000000Z'
                        updatedAt: '2025-03-01T20:01:07.000000Z'
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: 9e5489d0-5268-45d5-a79a-75e09a3e9422
                        teamId:
                          type: string
                          example: 9e5489a4-fa7c-4cf7-9a18-9a5b620e58e8
                        name:
                          type: string
                          example: 'CDE - Click Data Enrichment'
                        description:
                          type: string
                          example: 'Add CDE to each link'
                        status:
                          type: string
                          example: published
                        createdAt:
                          type: string
                          example: '2025-03-01T20:01:05.000000Z'
                        updatedAt:
                          type: string
                          example: '2025-03-01T20:01:07.000000Z'
                  links:
                    type: object
                    properties:
                      first:
                        type: string
                        example: 'https://api.301.pro/v1/team/9e5489a4-fa7c-4cf7-9a18-9a5b620e58e8/campaigns?page=1'
                      last:
                        type: string
                        example: 'https://api.301.pro/v1/team/9e5489a4-fa7c-4cf7-9a18-9a5b620e58e8/campaigns?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/9e5489a4-fa7c-4cf7-9a18-9a5b620e58e8/campaigns?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/9e5489a4-fa7c-4cf7-9a18-9a5b620e58e8/campaigns'
                      per_page:
                        type: integer
                        example: 15
                      to:
                        type: integer
                        example: 1
                      total:
                        type: integer
                        example: 1
      tags:
        - Campaigns
    post:
      summary: 'Create a Campaign'
      operationId: createACampaign
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  id: 9e54c5fe-dbf5-4d06-8cef-781bf72b89eb
                  teamId: 9e54c5e2-e868-4d37-9a0c-66dd0dc3073d
                  name: 'CDE - Click Data Enrichment'
                  description: 'Add CDE to each link'
                  status: published
                  createdAt: '2025-03-01T22:49:22.000000Z'
                  updatedAt: '2025-03-01T22:49:23.000000Z'
                properties:
                  id:
                    type: string
                    example: 9e54c5fe-dbf5-4d06-8cef-781bf72b89eb
                  teamId:
                    type: string
                    example: 9e54c5e2-e868-4d37-9a0c-66dd0dc3073d
                  name:
                    type: string
                    example: 'CDE - Click Data Enrichment'
                  description:
                    type: string
                    example: 'Add CDE to each link'
                  status:
                    type: string
                    example: published
                  createdAt:
                    type: string
                    example: '2025-03-01T22:49:22.000000Z'
                  updatedAt:
                    type: string
                    example: '2025-03-01T22:49:23.000000Z'
      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
    parameters:
      -
        in: path
        name: team_id
        description: 'The ID of the team.'
        example: 9e5489a4-fa7c-4cf7-9a18-9a5b620e58e8
        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:
                type: object
                example:
                  id: 9e54c5fe-dbf5-4d06-8cef-781bf72b89eb
                  teamId: 9e54c5e2-e868-4d37-9a0c-66dd0dc3073d
                  name: 'CDE - Click Data Enrichment'
                  description: 'Add CDE to each link'
                  status: published
                  createdAt: '2025-03-01T22:49:22.000000Z'
                  updatedAt: '2025-03-01T22:49:23.000000Z'
                properties:
                  id:
                    type: string
                    example: 9e54c5fe-dbf5-4d06-8cef-781bf72b89eb
                  teamId:
                    type: string
                    example: 9e54c5e2-e868-4d37-9a0c-66dd0dc3073d
                  name:
                    type: string
                    example: 'CDE - Click Data Enrichment'
                  description:
                    type: string
                    example: 'Add CDE to each link'
                  status:
                    type: string
                    example: published
                  createdAt:
                    type: string
                    example: '2025-03-01T22:49:22.000000Z'
                  updatedAt:
                    type: string
                    example: '2025-03-01T22:49:23.000000Z'
      tags:
        - Campaigns
    put:
      summary: 'Update a Campaign'
      operationId: updateACampaign
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  id: 9e54c5fe-dbf5-4d06-8cef-781bf72b89eb
                  teamId: 9e54c5e2-e868-4d37-9a0c-66dd0dc3073d
                  name: 'CDE - Click Data Enrichment'
                  description: 'Add CDE to each link'
                  status: published
                  createdAt: '2025-03-01T22:49:22.000000Z'
                  updatedAt: '2025-03-01T22:49:23.000000Z'
                properties:
                  id:
                    type: string
                    example: 9e54c5fe-dbf5-4d06-8cef-781bf72b89eb
                  teamId:
                    type: string
                    example: 9e54c5e2-e868-4d37-9a0c-66dd0dc3073d
                  name:
                    type: string
                    example: 'CDE - Click Data Enrichment'
                  description:
                    type: string
                    example: 'Add CDE to each link'
                  status:
                    type: string
                    example: published
                  createdAt:
                    type: string
                    example: '2025-03-01T22:49:22.000000Z'
                  updatedAt:
                    type: string
                    example: '2025-03-01T22:49:23.000000Z'
      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: 9e5489a4-fa7c-4cf7-9a18-9a5b620e58e8
        required: true
        schema:
          type: string
      -
        in: path
        name: id
        description: 'The ID of the campaign.'
        example: 9e54c5fe-dbf5-4d06-8cef-781bf72b89eb
        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:
                  data:
                    -
                      id: 9e5c7b08-b278-4450-9bb3-2f4537518919
                      subjectType: campaign
                      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: campaign
                        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: campaign
                        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:
        - 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:
                  id: 9e5c7b08-b278-4450-9bb3-2f4537518919
                  subjectType: campaign
                  subjectId: 9e522e02-f1c7-4c1e-ba56-bafdfa930a69
                  pixelType: FacebookPixel
                  pixelTypeDisplay: 'Facebook Pixel'
                  pixelTrackingId: '5884321354687987'
                  description: '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
                properties:
                  id:
                    type: string
                    example: 9e5c7b08-b278-4450-9bb3-2f4537518919
                  subjectType:
                    type: string
                    example: campaign
                  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: '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
      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: 9e5489a4-fa7c-4cf7-9a18-9a5b620e58e8
        required: true
        schema:
          type: string
      -
        in: path
        name: campaign_id
        description: 'The ID of the campaign.'
        example: 9e54c5fe-dbf5-4d06-8cef-781bf72b89eb
        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:
                  id: 9e5c7b08-b278-4450-9bb3-2f4537518919
                  subjectType: campaign
                  subjectId: 9e522e02-f1c7-4c1e-ba56-bafdfa930a69
                  pixelType: FacebookPixel
                  pixelTypeDisplay: 'Facebook Pixel'
                  pixelTrackingId: '5884321354687987'
                  description: '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
                properties:
                  id:
                    type: string
                    example: 9e5c7b08-b278-4450-9bb3-2f4537518919
                  subjectType:
                    type: string
                    example: campaign
                  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: '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
      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:
                  id: 9e5c7b08-b278-4450-9bb3-2f4537518919
                  subjectType: campaign
                  subjectId: 9e522e02-f1c7-4c1e-ba56-bafdfa930a69
                  pixelType: FacebookPixel
                  pixelTypeDisplay: 'Facebook Pixel'
                  pixelTrackingId: '5884321354687987'
                  description: '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
                properties:
                  id:
                    type: string
                    example: 9e5c7b08-b278-4450-9bb3-2f4537518919
                  subjectType:
                    type: string
                    example: campaign
                  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: '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
      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: 9e5489a4-fa7c-4cf7-9a18-9a5b620e58e8
        required: true
        schema:
          type: string
      -
        in: path
        name: campaign_id
        description: 'The ID of the campaign.'
        example: 9e54c5fe-dbf5-4d06-8cef-781bf72b89eb
        required: true
        schema:
          type: string
      -
        in: path
        name: id
        description: 'The ID of the pixel.'
        example: 9e56b73b-06ce-48fd-ab99-d740ebff34d0
        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: 9e5489a4-fa7c-4cf7-9a18-9a5b620e58e8
        required: true
        schema:
          type: string
      -
        in: path
        name: campaign_id
        description: 'The ID of the campaign.'
        example: 9e54c5fe-dbf5-4d06-8cef-781bf72b89eb
        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: 9e5489a4-fa7c-4cf7-9a18-9a5b620e58e8
        required: true
        schema:
          type: string
      -
        in: path
        name: campaign_id
        description: 'The ID of the campaign.'
        example: 9e54c5fe-dbf5-4d06-8cef-781bf72b89eb
        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: 9e5489a4-fa7c-4cf7-9a18-9a5b620e58e8
        required: true
        schema:
          type: string
      -
        in: path
        name: campaign_id
        description: 'The ID of the campaign.'
        example: 9e54c5fe-dbf5-4d06-8cef-781bf72b89eb
        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: 9e5489a4-fa7c-4cf7-9a18-9a5b620e58e8
        required: true
        schema:
          type: string
      -
        in: path
        name: campaign_id
        description: 'The ID of the campaign.'
        example: 9e54c5fe-dbf5-4d06-8cef-781bf72b89eb
        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: 9e5489a4-fa7c-4cf7-9a18-9a5b620e58e8
        required: true
        schema:
          type: string
      -
        in: path
        name: campaign_id
        description: 'The ID of the campaign.'
        example: 9e54c5fe-dbf5-4d06-8cef-781bf72b89eb
        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: f5d52349-4a64-419c-9afa-13b0cc7dbc82
        required: true
        schema:
          type: string
      -
        in: path
        name: campaign_id
        description: 'The ID of the campaign.'
        example: 9e54c5fe-dbf5-4d06-8cef-781bf72b89eb
        required: true
        schema:
          type: string
      -
        in: path
        name: pixel_id
        description: 'The uuid of the Campaign Pixel'
        example: f6f03f41-fcb1-4f98-8911-262ddecd31e7
        required: true
        schema:
          type: string
  '/v1/team/{team_id}/utils/customer-id-encode':
    post:
      summary: Utilities
      operationId: utilities
      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.'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  status: success
                  data:
                    -
                      customerNumber: 402-456-7777
                      sanitized: '4024567777'
                      encoded: aBcdEf
                properties:
                  status:
                    type: string
                    example: success
                  data:
                    type: array
                    example:
                      -
                        customerNumber: 402-456-7777
                        sanitized: '4024567777'
                        encoded: aBcdEf
                    items:
                      type: object
                      properties:
                        customerNumber:
                          type: string
                          example: 402-456-7777
                          description: 'The Original Customer Number Provided To Encode.'
                        sanitized:
                          type: string
                          example: '4024567777'
                          description: 'The sanitized version of the customer number'
                        encoded:
                          type: string
                          example: aBcdEf
                          description: 'The encoded version of the customer number'
      tags:
        - Utilities
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                customerNumbers:
                  type: array
                  description: 'The customer numbers to encode.'
                  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: 9e5489a4-fa7c-4cf7-9a18-9a5b620e58e8
        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.0
                  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: null
                      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'
                    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.0
                    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: null
                            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.'
                        description: 'Details about the Prolink that was clicked.'
                      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: []
