View Categories

API Calls for Object Type Associations

1 min read

Title: API Calls for Object Type Associations

Overview
When making API calls involving Object Type associations, it is mandatory to include specific LeadDetails attributes in the request payload. Without this configuration, the API will not process object associations correctly.

Applicability
This applies to all API calls where leads are being associated with a specific Object Type.

Required Configuration

To ensure the API functions correctly with object associations, include the following block at the beginning of your JSON request body:

“LeadDetails”: [
  {
    “Attribute”: “LeadType”,
    “Value”: “OT_1”
  }
]

Explanation

  • The LeadType attribute identifies the Object Type.

  • The value (e.g., OT_1) should correspond to the appropriate Object Type configured in your account.

  • Including this attribute ensures the API correctly processes and maps the object association.

Expected Outcome
Once the LeadDetails block is added correctly:

  • The API will successfully process object associations.

  • The related Object Type mapping will function as intended.

Additional Notes

  • Ensure the Object Type value (OT_1) matches the configured Object Type in your system.

  • Updated API documentation will be shared shortly to provide further clarity on object association calls.

  • If you encounter any issues while making these API calls, please verify the payload structure and Object Type value.

For further assistance, please reach out to the Support team.

What are your Feelings
Scroll to Top