SHshiprush
Custom table record links

Link custom table records to another custom table record

Resources that can be linked to records from a custom table (called custom objects in the API) can be manipulated in a bulk ID-list format. To use custom table record links you must first add a many-to-many custom field definition to the resource. When you pass the IDs of custom table records to link to the feature, the existing list of links will be replaced.

Examples of linking custom objects to resources with a many-to-many customer field:

  • Products
  • Releases
  • Features
  • Ideas
  • Initiatives
  • Goals
  • Organizations

Custom tables are an Enterprise+ exclusive feature.

put/custom_object_records/{id}

Request

Path parameters

idstring required

Id identifier

Request body

Example request

{
  "requirement": {
    "custom_object_links": {
      "customers": [
        "640362830"
      ]
    }
  }
}

Response

Successful operation

Example response

{
  "custom_object_record": {
    "id": "640362830",
    "product_id": "131414752",
    "key": "customers",
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "custom_fields": [
      {
        "id": 262515157,
        "key": "name",
        "name": "Name",
        "updatedAt": "2019-01-01T00:00:00Z",
        "type": "string",
        "value": "Acme parent corp"
      },
      {
        "id": 883926222,
        "key": "website",
        "name": "Website",
        "updatedAt": "2019-01-01T00:00:00Z",
        "type": "url",
        "value": "www.acmeparent.com"
      }
    ],
    "custom_object_links": [],
    "linked_records": [
      {
        "key": "customers",
        "name": "Customers",
        "record_type": "Ideas::Idea",
        "record_id": 162120796
      },
      {
        "key": "revenue",
        "name": "Revenue",
        "record_type": "Ideas::Idea",
        "record_id": 58056975
      },
      {
        "key": "submitters",
        "name": "Submitters",
        "record_type": "Ideas::Idea",
        "record_id": 58056975
      }
    ],
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z"
    }
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.