HighLevel: Create Relation for you associated entities

← Associations operations · Get started

Operation gohighlevel.create_relation

Provider route: POST /associations/relations. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/gohighlevel with npm, or alter-sdk-gohighlevel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HighLevelIntegration } from "@alter-ai/gohighlevel";

async function execute(input: Parameters<HighLevelIntegration["associations"]["createRelation"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HighLevelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.associations.createRelation(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_gohighlevel import HighLevelIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HighLevelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.associations.create_relation(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
body	Model	Required within parent	Expand Create Relation for you associated entities — request body — body

Referenced models: Create Relation for you associated entities — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Delete Relation — response body

Referenced models: Delete Relation — response body

Schemas

Delete Relation — response body

Field	Type	Presence	Description and constraints
$	object	Root
associationType	object	Required within parent	Association Type can be USER_DEFINED or SYSTEM_DEFINED
firstObjectKey	object	Required within parent	First Objects Key
firstObjectLabel	object	Required within parent	First Objects Association Label (custom_objects.children)
id	string	Required within parent
key	string	Required within parent	First Objects Association Label (custom_objects.children)
locationId	string	Required within parent
secondObjectKey	object	Required within parent	Second Objects Key
secondObjectLabel	object	Required within parent	Second Object Association Label (contact)

Create Relation for you associated entities — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
associationId	string	Required within parent	Association's Id
firstRecordId	string	Required within parent	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
locationId	string	Required within parent	Your Sub Account's ID
secondRecordId	string	Required within parent	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

Policy, approvals and errors

SDK function policy ID: gohighlevel.create_relation. Catalog operation: create-relation. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["associations/relation.write"]

Pinned headers: {"Version": "v3"}

Official provider source