Schemas-Associations

BadRequestDTO

statusCode
number
Example:
400
message
string
Example:
Bad Request
Example 
{
  "statusCode": 400,
  "message": "Bad Request"
}

UnauthorizedDTO

statusCode
number
Example:
401
message
string
Example:
Invalid token: access token is invalid
error
string
Example:
Unauthorized
Example 
{
  "statusCode": 401,
  "message": "Invalid token: access token is invalid",
  "error": "Unauthorized"
}

UnprocessableDTO

statusCode
number
Example:
422
message
array[string]
Example:
["Unprocessable Entity"]
error
string
Example:
Unprocessable Entity
Example 
{
  "statusCode": 422,
  "message": [
    "Unprocessable Entity"
  ],
  "error": "Unprocessable Entity"
}

createRelationReqDto

locationId
string
required

Your Sub Account's ID

Example:
clF1LD04GTUKN3b3XuOj
associationId
string
required

Association's Id

Example:
ve9EPM428h8vShlRW1KT
firstRecordId
string
required

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

Example:
ve9EPM428h8vShlRW1KT
secondRecordId
string
required

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

Example:
ve9EPM428h8vShlRW1KT
Example 
{
  "locationId": "clF1LD04GTUKN3b3XuOj",
  "associationId": "ve9EPM428h8vShlRW1KT",
  "firstRecordId": "ve9EPM428h8vShlRW1KT",
  "secondRecordId": "ve9EPM428h8vShlRW1KT"
}

GetPostSuccessfulResponseDto

locationId
string
required
Example:
string
id
string
required
Example:
ve9EPM428h8vShlRW1KT
key
string
required

First Objects Association Label (custom_objects.children)

Example:
student
firstObjectLabel
object
required

First Objects Association Label (custom_objects.children)

Example:
student
firstObjectKey
object
required

First Objects Key

Example:
custom_objects.children
secondObjectLabel
object
required

Second Object Association Label (contact)

Example:
Teacher
secondObjectKey
object
required

Second Objects Key

Example:
contact
associationType
object
required

Association Type can be USER_DEFINED or SYSTEM_DEFINED

Example:
USER_DEFINED
Example 
 {
  "locationId": "string",
  "id": "ve9EPM428h8vShlRW1KT",
  "key": "student",
  "firstObjectLabel": "student",
  "firstObjectKey": "custom_objects.children",
  "secondObjectLabel": "Teacher",
  "secondObjectKey": "contact",
  "associationType": "USER_DEFINED"
}

createAssociationReqDto

locationId
string
required
Example:
string
key
string
required

Association's Unique key

Example:
student_teacher
firstObjectLabel
object
required

First Objects Association Label (custom_objects.children)

Example:
student
firstObjectKey
object
required

First Objects Key

Example:
custom_objects.children
secondObjectLabel
object
required

Second Object Association Label (contact)

Example:
Teacher
secondObjectKey
object
required

Second Objects Key

Example:
contact
Example 
 {
  "locationId": "string",
  "key": "student_teacher",
  "firstObjectLabel": "student",
  "firstObjectKey": "custom_objects.children",
  "secondObjectLabel": "Teacher",
  "secondObjectKey": "contact"
}

UpdateAssociationReqDto

firstObjectLabel
object
required
Example:
student
secondObjectLabel
object
required
Example:
tutor
Example 
{
  "firstObjectLabel": "student",
  "secondObjectLabel": "tutor"
}

DeleteAssociationsResponseDTO

deleted
boolean
required

Deletion status

Example:
true
id
string
required

Association Id

Example:
6d6f6e676f5f6576656e7473
message
string
required
Example:
Association deleted successfully
Example 
{
  "deleted": true,
  "id": "6d6f6e676f5f6576656e7473",
  "message": "Association deleted successfully"
}