Create Default

curl --request PUT \
  --url https://api.hubapi.com/crm/v4/objects/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId} \
  --header 'Authorization: Bearer <token>'

{
  "completedAt": "2023-11-07T05:31:56Z",
  "results": [
    {
      "associationSpec": {
        "associationCategory": "HUBSPOT_DEFINED",
        "associationTypeId": 123
      },
      "from": {
        "id": "<string>"
      },
      "to": {
        "id": "<string>"
      }
    }
  ],
  "startedAt": "2023-11-07T05:31:56Z",
  "status": "CANCELED",
  "errors": [
    {
      "category": "<string>",
      "context": {},
      "errors": [
        {
          "message": "<string>",
          "code": "<string>",
          "context": "{missingScopes=[scope1, scope2]}",
          "in": "<string>",
          "subCategory": "<string>"
        }
      ],
      "links": {},
      "message": "<string>",
      "status": "<string>",
      "id": "<string>",
      "subCategory": {}
    }
  ],
  "links": {},
  "numErrors": 123,
  "requestedAt": "2023-11-07T05:31:56Z"
}

PUT

crm

objects

{fromObjectType}

{fromObjectId}

associations

default

{toObjectType}

{toObjectId}

Create Default

curl --request PUT \
  --url https://api.hubapi.com/crm/v4/objects/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId} \
  --header 'Authorization: Bearer <token>'

{
  "completedAt": "2023-11-07T05:31:56Z",
  "results": [
    {
      "associationSpec": {
        "associationCategory": "HUBSPOT_DEFINED",
        "associationTypeId": 123
      },
      "from": {
        "id": "<string>"
      },
      "to": {
        "id": "<string>"
      }
    }
  ],
  "startedAt": "2023-11-07T05:31:56Z",
  "status": "CANCELED",
  "errors": [
    {
      "category": "<string>",
      "context": {},
      "errors": [
        {
          "message": "<string>",
          "code": "<string>",
          "context": "{missingScopes=[scope1, scope2]}",
          "in": "<string>",
          "subCategory": "<string>"
        }
      ],
      "links": {},
      "message": "<string>",
      "status": "<string>",
      "id": "<string>",
      "subCategory": {}
    }
  ],
  "links": {},
  "numErrors": 123,
  "requestedAt": "2023-11-07T05:31:56Z"
}

Supported products

Requires one of the following products or higher.

Marketing Hub -Free

Sales Hub -Free

Service Hub -Free

Content Hub -Starter

Required Scopes

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

fromObjectId

string

required

The ID of the source object in the association.

fromObjectType

string

required

The type of the source object in the association.

toObjectId

string

required

The ID of the target object in the association.

toObjectType

string

required

The type of the target object in the association.

Response

successful operation

completedAt

string<date-time>

required

The timestamp when the batch process was completed, in ISO 8601 format.

results

object[]

required

Show child attributes

results.associationSpec

object

required

Defines the type, direction, and details of the relationship between two CRM objects.

Show child attributes

results.associationSpec.associationCategory

enum<string>

required

The category of the association, such as "HUBSPOT_DEFINED".

Available options:

HUBSPOT_DEFINED,

INTEGRATOR_DEFINED,

USER_DEFINED

results.associationSpec.associationTypeId

integer<int32>

required

The ID representing the specific type of association.

results.from

object

required

Show child attributes

results.from.id

string

required

ID of the object

results.to

object

required

Show child attributes

results.to.id

string

required

ID of the object

startedAt

string<date-time>

required

The timestamp when the batch process began execution, in ISO 8601 format.

status

enum<string>

required

The status of the batch processing request: "PENDING", "PROCESSING", "CANCELLED", or "COMPLETE".

Available options:

CANCELED,

COMPLETE,

PENDING,

PROCESSING

errors

object[]

Show child attributes

errors.category

string

required

The main category of the error.

errors.context

object

required

Additional context-specific information related to the error.

Show child attributes

errors.context.{key}

string[]

errors.errors

object[]

required

The detailed error objects.

Show child attributes

errors.errors.message

string

required

A human readable message describing the error along with remediation steps where appropriate

errors.errors.code

string

The status code associated with the error detail

errors.errors.context

object

Context about the error condition

Show child attributes

errors.errors.context.{key}

string[]

Example:

"{missingScopes=[scope1, scope2]}"

errors.errors.in

string

The name of the field or parameter in which the error was found.

errors.errors.subCategory

string

A specific category that contains more specific detail about the error

errors.links

object

required

URLs linking to documentation or resources associated with the error.

Show child attributes

errors.links.{key}

string

errors.message

string

required

A human-readable string describing the error and possible remediation steps.

errors.status

string

required

The HTTP status code associated with the error.

errors.id

string

A unique ID for the error instance.

errors.subCategory

object

A more specific error category within each main category.

links

object

An object containing relevant links related to the batch request.

Show child attributes

links.{key}

string

numErrors

integer<int32>

The number of errors encountered during the batch processing.

requestedAt

string<date-time>

The timestamp when the batch process was initiated, in ISO 8601 format.