openapi: 3.2.0
info:
  title: Associations Relations API
  description: Documentation for Associations API
  version: '1.0'
  contact: {}
servers:
- url: https://services.leadconnectorhq.com
tags:
- name: Relations
  description: Documentation for Associations API
paths:
  /associations/relations:
    post:
      operationId: create-relation
      summary: Create Relation for you associated entities
      description: Create Relation.Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-293776/cd0f4122abc04d3
      externalDocs:
        url: https://doc.clickup.com/8631005/d/h/87cpx-293776/cd0f4122abc04d3
        description: Click here for more information
      parameters:
      - name: Version
        in: header
        description: API Version
        required: true
        schema:
          type: string
          enum:
          - '2021-07-28'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createRelationReqDto'
      responses:
        '201':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPostSuccessfulResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: ../common/common-schemas.json#/components/schemas/BadRequestDTO
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: ../common/common-schemas.json#/components/schemas/UnauthorizedDTO
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: ../common/common-schemas.json#/components/schemas/UnprocessableDTO
      tags:
      - Relations
      security:
      - bearer:
        - associations/relation.write
  /associations/relations/{recordId}:
    get:
      operationId: get-relations-by-record-id
      summary: Get all relations By record Id
      description: Get all relations by record Id
      parameters:
      - name: Version
        in: header
        description: API Version
        required: true
        schema:
          type: string
          enum:
          - '2021-07-28'
      - name: recordId
        required: true
        in: path
        schema:
          type: string
      - name: locationId
        required: true
        in: query
        description: Your Sub Account's ID
        schema:
          example: clF1LD04GTUKN3b3XuOj
          type: string
      - name: skip
        required: true
        in: query
        schema:
          example: '10'
          type: number
      - name: limit
        required: true
        in: query
        schema:
          example: '100'
          type: number
      - name: associationIds
        required: false
        in: query
        description: Association Ids
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPostSuccessfulResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: ../common/common-schemas.json#/components/schemas/BadRequestDTO
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: ../common/common-schemas.json#/components/schemas/UnauthorizedDTO
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: ../common/common-schemas.json#/components/schemas/UnprocessableDTO
      tags:
      - Relations
      security:
      - bearer:
        - associations/relation.readonly
  /associations/relations/{relationId}:
    delete:
      operationId: delete-relation
      summary: Delete Relation
      parameters:
      - name: Version
        in: header
        description: API Version
        required: true
        schema:
          type: string
          enum:
          - '2021-07-28'
      - name: relationId
        required: true
        in: path
        schema:
          type: string
      - name: locationId
        required: true
        in: query
        description: Your Sub Account's ID
        schema:
          example: clF1LD04GTUKN3b3XuOj
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPostSuccessfulResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: ../common/common-schemas.json#/components/schemas/BadRequestDTO
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: ../common/common-schemas.json#/components/schemas/UnauthorizedDTO
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: ../common/common-schemas.json#/components/schemas/UnprocessableDTO
      tags:
      - Relations
      security:
      - bearer:
        - associations/relation.write
components:
  schemas:
    GetPostSuccessfulResponseDto:
      type: object
      properties:
        locationId:
          type: string
          example: string
        id:
          type: string
          example: ve9EPM428h8vShlRW1KT
        key:
          type: string
          example: student
          description: First Objects Association Label (custom_objects.children)
        firstObjectLabel:
          type: object
          example: student
          description: First Objects Association Label (custom_objects.children)
        firstObjectKey:
          type: object
          example: custom_objects.children
          description: First Objects Key
        secondObjectLabel:
          type: object
          example: Teacher
          description: Second Object Association Label (contact)
        secondObjectKey:
          type: object
          example: contact
          description: Second Objects Key
        associationType:
          type: object
          example: USER_DEFINED
          description: Association Type can be USER_DEFINED or SYSTEM_DEFINED
      required:
      - locationId
      - id
      - key
      - firstObjectLabel
      - firstObjectKey
      - secondObjectLabel
      - secondObjectKey
      - associationType
    createRelationReqDto:
      type: object
      properties:
        locationId:
          type: string
          example: clF1LD04GTUKN3b3XuOj
          description: Your Sub Account's ID
        associationId:
          type: string
          example: ve9EPM428h8vShlRW1KT
          description: Association's Id
        firstRecordId:
          type: string
          example: ve9EPM428h8vShlRW1KT
          description: 'First Record''s Id. For instance, if you have an association between a contact and a custom object, and you specify the contact as the first object while creating the association, then your firstRecordId would be the contactId '
        secondRecordId:
          type: string
          example: ve9EPM428h8vShlRW1KT
          description: Second Record's Id.For instance, if you have an association between a contact and a custom object, and you specify the custom object as the second entity while creating the association, then your secondRecordId would be the customObject record Id
      required:
      - locationId
      - associationId
      - firstRecordId
      - secondRecordId
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      name: Authorization
      in: header
      description: Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.
      type: http
    Location-Access:
      scheme: bearer
      bearerFormat: JWT
      name: Authorization
      in: header
      description: Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.
      type: http
    Location-Access-Only:
      scheme: bearer
      bearerFormat: JWT
      name: Authorization
      in: header
      description: Use the Access Token generated with user type as Sub-Account.
      type: http
    Agency-Access:
      scheme: bearer
      bearerFormat: JWT
      name: Authorization
      in: header
      description: Use the Access Token generated with user type as Agency (OR) Private Integration Token of Agency.
      type: http
x-tagGroups:
  name: Associations
  tags:
  - Associations
  - Relations