{"note":"OpenAPI conversion -- returning structured metadata","name":"hubspot-associations","description":"Associations","version":"v4","base_url":"https://api.hubapi.com","endpoints":10,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Associations\n@base https://api.hubapi.com\n@version v4\n@auth OAuth2 | OAuth2 | ApiKey private-app-legacy in header | ApiKey private-app in header\n@endpoints 10\n@toc crm(10)\n\n@endpoint POST /crm/v4/associations/usage/high-usage-report/{userId}\n@desc Report high usage\n@required {userId: int(int32)}\n@returns(200) {enqueueTime: map{dateOnly: bool, timeZoneShift: int(int32), value: int(int32)}, userEmail: str, userId: int(int32)} # successful operation\n\n@endpoint POST /crm/v4/associations/{fromObjectType}/{toObjectType}/batch/archive\n@desc Remove associations\n@required {fromObjectType: str, toObjectType: str, inputs: [map{from!: map, to!: [map]}]}\n@returns(204) No content\n\n@endpoint POST /crm/v4/associations/{fromObjectType}/{toObjectType}/batch/associate/default\n@desc Associate records (default)\n@required {fromObjectType: str, toObjectType: str, inputs: [map{from!: map, to!: map}]}\n@returns(200) {completedAt: str(date-time), errors: [map], links: map, numErrors: int(int32), requestedAt: str(date-time), results: [map], startedAt: str(date-time), status: str} # successful operation\n\n@endpoint POST /crm/v4/associations/{fromObjectType}/{toObjectType}/batch/create\n@desc Associate records (labelled)\n@required {fromObjectType: str, toObjectType: str, inputs: [map{from!: map, to!: map, types!: [map]}]}\n@returns(201) {completedAt: str(date-time), links: map, requestedAt: str(date-time), results: [map], startedAt: str(date-time), status: str} # successful operation\n@returns(207) {completedAt: str(date-time), errors: [map], links: map, numErrors: int(int32), requestedAt: str(date-time), results: [map], startedAt: str(date-time), status: str} # multiple statuses\n\n@endpoint POST /crm/v4/associations/{fromObjectType}/{toObjectType}/batch/labels/archive\n@desc Delete specific labels\n@required {fromObjectType: str, toObjectType: str, inputs: [map{from!: map, to!: map, types!: [map]}]}\n@returns(204) No content\n\n@endpoint POST /crm/v4/associations/{fromObjectType}/{toObjectType}/batch/read\n@desc Retrieve associations\n@required {fromObjectType: str, toObjectType: str, inputs: [map{after: str, id!: str}]}\n@returns(200) {completedAt: str(date-time), links: map, requestedAt: str(date-time), results: [map], startedAt: str(date-time), status: str} # successful operation\n@returns(207) {completedAt: str(date-time), errors: [map], links: map, numErrors: int(int32), requestedAt: str(date-time), results: [map], startedAt: str(date-time), status: str} # multiple statuses\n\n@endpoint PUT /crm/v4/objects/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}\n@desc Associate records (default)\n@required {fromObjectId: str, fromObjectType: str, toObjectId: str, toObjectType: str}\n@returns(200) {completedAt: str(date-time), errors: [map], links: map, numErrors: int(int32), requestedAt: str(date-time), results: [map], startedAt: str(date-time), status: str} # successful operation\n\n@endpoint GET /crm/v4/objects/{objectType}/{objectId}/associations/{toObjectType}\n@desc Retrieve all associations by object type\n@required {objectId: str, objectType: str, toObjectType: str}\n@optional {after: str # The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results., limit: int(int32)=500 # The maximum number of results to display per page.}\n@returns(200) {paging: map{next: map{after: str, link: str}}, results: [map]} # successful operation\n\n@endpoint PUT /crm/v4/objects/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}\n@desc Associate records (labelled)\n@required {objectId: str, objectType: str, toObjectId: str, toObjectType: str}\n@returns(201) {fromObjectId: str, fromObjectTypeId: str, labels: [str], toObjectId: str, toObjectTypeId: str} # successful operation\n\n@endpoint DELETE /crm/v4/objects/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}\n@desc Delete associations between two records\n@required {objectId: str, objectType: str, toObjectId: str, toObjectType: str}\n@returns(204) No content\n\n@end\n"}