Overview

Creates relationships to pre-existing record from a record list.

URL Arguments

Name Type Description Required
<record ID> <string> Target record ID. True.
<report ID> <string> Report ID for Saved Report. True.
<relationship link> <string> Link between targeted and related records. True.

Request



Response Arguments

Name Type Description
record Array The record linked to related records.
related_records Array Record IDs that were associated.

Response

    "record": {
        "id": "da6a3741-2a81-ba7f-f249-512d0932e94e",
        "name": "Slender Broadband Inc - 1000 units",
        "date_entered": "2013-02-26T19:12:00+00:00",
        "date_modified": "2013-02-26T19:12:00+00:00",
        "modified_user_id": "1",
        "modified_by_name": "Administrator",
        "created_by": "1",
        "created_by_name": "Administrator",
        "description": "",
        "img": "",
        "last_activity_date": "2013-02-28T18:21:00+00:00",
        "deleted": false,
        "assigned_user_id": "seed_max_id",
        "assigned_user_name": "Max Jensen",
        "team_name": [
            {
                "id": "East",
                "name": "East",
                "name_2": "",
                "primary": false
            },
            {
                "id": "West",
                "name": "West",
                "name_2": "",
                "primary": true
            }
        ],
        "opportunity_type": "",
        "account_name": "Slender Broadband Inc",
        "account_id": "181461c6-dc81-1115-1fe0-512d092e8f15",
        "campaign_id": "",
        "campaign_name": "",
        "lead_source": "Campaign",
        "amount": "25000",
        "base_rate": "1",
        "amount_usdollar": "25000",
        "currency_id": "-99",
        "currency_name": "",
        "currency_symbol": "",
        "date_closed": "2013-02-27",
        "date_closed_timestamp": "1361992480",
        "next_step": "",
        "sales_stage": "Needs Analysis",
        "sales_status": "New",
        "probability": "90",
        "best_case": "25000",
        "worst_case": "25000",
        "commit_stage": "include",
        "my_favorite": false,
        "_acl": {
            "fields": {

            }
        }
    },
    "related_records": [
        success: [
            "e689173e-c953-1e14-c215-512d0927e7a2",
            "da6a3741-2a81-ba7f-f249-512d0932e94e",
            "181461c6-dc81-1115-1fe0-512d092e8f15"
        ],
        error: []
    ]
}

Change Log

Version Change
v10 (7.2.0) Added /<module>/:record/link/:link_name/add_record_list/:remote_id POST endpoint.