Create a Single Object Type Association
Creates a single Association between a parent Object Type and a child Object Type. This lets you link related Object Types, such as students with their parents.
API URL
URL
POST
https://{host}/v2/LeadTypes.svc/LeadTypeAssociation/Create?accessKey=AccessKey&secretKey=SecretKey
Request
Content-Type: application/json
JSON Body/Payload
{
"ParentLeadId": "79e04544-5e48-4328-8e2c-767f9cda4e17",
"ChildLeadId": "06b89148-17b1-4c5a-9c45-af3cfef8652a",
"ParentLeadType": "OT_0",
"ChildLeadType": "OT_1",
"AssociationFieldSchemaName": "LeadTypeAssociation_OT_0_OT_1"
}
Request Parameters
| Parameter | Description |
|---|---|
| ParentLeadId | Pass the Lead Id for the Parent Object Type. To obtain this, refer to the Get Lead by Email API or Get Lead by Phone API. The |
| ChildLeadId | Pass the Lead Id for the Child Object Type. To obtain this, refer to the Get Lead by Email API or Get Lead by Phone API. The |
| ParentLeadType | Pass the Internal Name for the Parent Object Type.
|
| ChildLeadType | Pass the Internal Name for the Child Object Type.
|
| AssociationFieldSchemaName | Pass the schema name of the Parent Object Type’s Associated Field Name. To get this value, call Get Object Types Associations and use the
|
Response
200 OK
Content-Type: application/json
{
"Status": "Success",
"Message": {
"IsSuccessful": true
}
}
HTTP Response Codes
| Code | Description |
|---|---|
| 200 OK |
This is the status code for successful API call. |
| 401 Unauthorized |
The API call was made with invalid access credentials. Check your AccessKey and SecretKey. |
| 400 Bad Request |
The message body on the request is not as per API specification. Make sure that content type is set to “application/json” and the JSON body has correct attribute names and structure. |
| 404 Not Found |
The API could not be found. Please check the API signature. |
| 429 Too Many Requests |
API calls exceeded the limit of 25 in 5 second(s) |
| 500 Internal Server Error |
The API called failed. There could be many reasons for it. Check the exception message to get more details. |
