Merge Link Table Records

Use this endpoint to merge (i.e. populate) link table records into an existing link table. For a given link table, an array of record data that contain link names and their corresponding link URL values are specified.

Note: The Responsys Advanced API is generally available for all Responsys customers.

Service URL:

/rest/api/v1.3/folders/{folderName}/linkTables/{linkTableName}/members

Required Path Parameters:

folderName – The name of the folder in Responsys where you want to merge records.

linkTableName – The link table name to merge records.

Request Method:

POST

Request Header:

Authorization=<AUTH_TOKEN>

Content-Type=application/json

Request Body - Required Properties:

recordData – Array of link records to merge into the link table.

  • link_name – Required when updating existing records. Must contain alphanumeric characters or underscores. Maximum 255 characters.
  • link_Url – Required when inserting new records. Maximum 4000 characters.

Request Body Notes

  • Up to 200 records can be merged in a single request.
  • Merge cannot be done on one field.

Sample Request Body

{
  "recordData": {
    "fieldNames": [
      "link_Url",
      "link_name"
    ],
    "records": [
      [
        "www.oracle.com",
        "siteurl"
      ],
      [
        "www.oracleblogs.com",
        "blogurl"
      ]
    ]
  }
}

Sample Response Body - Success

{
  "insertCount": 2,
  "totalCount": 2,
  "errorMessage": null,
  "updateCount": 0,
  "rejectedCount": 0,
  "links": [
    {
      "rel": "self",
      "href": "/rest/api/v1.3/folders/Folder_Name/linkTables/New_Link_Table/members",
      "method": "POST"
    },
    {
      "rel": "createLinkTable",
      "href": "/rest/api/v1.3/folders/Folder_Name/linkTables/New_Link_Table",
      "method": "POST"
    },
    {
      "rel": "deleteLinkTable",
      "href": "/rest/api/v1.3/folders/Folder_Name/linkTables/New_Link_Table",
      "method": "DELETE"
    }
  ]
}

Sample Response Body - Failure

400 Bad Request

Record limit exceeded, minimum of 200 records allowed per each API call: Requests fail if more than 200 records are sent in the request payload. The error resembles:

{
  "type": "",
  "title": "Record limit exceeded",
  "errorCode": "RECORD_LIMIT_EXCEEDED",
  "detail": "Record limit exceeded, maximum of 200 records are allowed per each api call",
  "errorDetails": []
}

Link name must be provided in order to merge link records: Requests fail if a link_name is not provided when updating existing records. Error resembles:

{
  "type": "",
  "title": "Invalid request parameters",
  "errorCode": "INVALID_PARAMETER",
  "detail": "LINK_NAME must be provided in order to merge link records",
  "errorDetails": []
}

You cannot merge without specifying the LINK_URL field in the field names: Requests fail if inserting new records and link url is missing. The error resembles:

{
  "type": "",
  "title": "Invalid request parameters",
  "errorCode": "INVALID_PARAMETER",
  "detail": "You cannot merge without specifying the LINK_URL field in the field names",
  "errorDetails": []
}