Delete Link Table Records

Use this interface to delete link records within a link table by specifying the linkNames to delete. Up to 10 linkNames can be deleted per request.

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:

DELETE

Request Header:

Authorization=<AUTH_TOKEN>

Content-Type=application/json

Request Body - Required Properties:

deleteType – Specifies the method to delete link records. Must be set to selected.

linkNames – Link Record Names to be deleted (maximum 10 link record names can be specified for deletion). Only the link record names specified in the request will be deleted from the link table.

Sample Request Body

{
  "deleteType": "selected",
  "linkNames": [
    "link_name_to_delete"
  ]
}

Sample Response Body - Success

{
  "result": "SUCCESS",
  "errorCode": null,
  "errorMsg": null,
  "deleteResults": [
    {
      "name": "link_name_to_delete",
      "success": true,
      "exceptionCode": null,
      "errorMessage": null
    }
  ],
  "links": [
    {
      "rel": "self",
      "href": "/rest/api/v1.3/folders/Folder_Name/linkTables/New_Link_Table/members",
      "method": "DELETE"
    },
    {
      "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"
    },
    {
      "rel": "mergeLinkRecords",
      "href": "/rest/api/v1.3/folders/Folder_Name/linkTables/New_Link_Table/members",
      "method": "POST"
    }
  ]
}

Sample Response Body - Failure

Invalid delete type parameters: Requests fail if the delete type specified is invalid. The delete type must be selected. The error resembles:

{
  "type": "",
  "title": "Invalid request parameters",
  "errorCode": "INVALID_PARAMETER ",
  "detail": "The delete type is not valid",
  "errorDetails": []
}

API limit exceeded: When the client application exceeds the throttling limit for this API, a 401 Unauthorized error is returned with the following error response body. Refer to Get Throttling Limits to learn more. Error resembles:

{
  "type": "",
  "title": "",
  "errorCode": "API_LIMIT_EXCEEDED ",
  "detail": "",
  "errorDetails": []
}

Folder name is not found: Requests fail if the folder name specified cannot be found. The error resembles:

{
  "type": "",
  "title": "Folder not found",
  "errorCode": "FOLDER_NOT_FOUND ",
  "detail": "The Folder name is not found",
  "errorDetails": []
}

Link Table not found: Requests fail if the specified link table name does not exist in Responsys. The error resembles:

{
  "type": "",
  "title": "Link Table not found",
  "errorCode": "LINK_TABLE_NOT_FOUND",
  "detail": "The Link Table is not found",
  "errorDetails": []
}

Unexpected Exception: Requests may fail if there are issues with the database. These are rare occurrences. If this happens, retry the request. The error resembles:

{
  "type": "",
  "title": "Unexpected exception",
  "errorCode": "UNEXPECTED_EXCEPTION",
  "detail": "Unexpected exception",
  "errorDetails": []
}

Record limit exceeded: Requests will fail if the number of link records to delete per API request exceeds 200. Modify the API request to delete fewer link record names and submit several requests. 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": []
}

No Link Record name found: Requests will fail if the link record name specified is not found in the link table. The error resembles:

{
  "type": "",
  "title": "Record not found",
  "errorCode": "RECORD_NOT_FOUND",
  "detail": "One or more link records are not found",
  "errorDetails": []
}

No Link Record name specified in the request: Requests will fail if there are no link record names (linkNames) specified in the request body. You must specify link names to delete. The error resembles:

{
  "type": "",
  "title": "Record not found",
  "errorCode": "INVALID_PARAMETER",
  "detail": "Link name is not found in the request",
  "errorDetails": []
}

No Link Records found in the link table: Requests will fail if there are no link records found in the link table. The error resembles:

{
  "type": "",
  "title": "Record not found",
  "errorCode": "RECORD_NOT_FOUND",
  "detail": "Link records in the request are not found in the link table",
  "errorDetails": []
}

Link Names are null or empty: Requests will fail if the linkNames specified in the request body are null or not specified. The error resembles:

{
  "type": "",
  "title": "Invalid request parameters",
  "errorCode": "INVALID_PARAMETER ",
  "detail": "One or more link names are null or empty",
  "errorDetails": []
}

Link name length exceeds character limit: Requests will fail if a link record name exceeds 255 characters. The error resembles:

{
  "type": "",
  "title": "Invalid request parameters",
  "errorCode": "INVALID_PARAMETER ",
  "detail": "ERROR: This field has a max length of 255 and value “…” is too large",
  "errorDetails": []
}

Duplicate Link Names: Requests will fail if duplicate link names are specified. The error resembles:

{
  "type": "",
  "title": "Invalid request parameters",
  "errorCode": "INVALID_PARAMETER ",
  "detail": "Duplicate link names are found in the request",
  "errorDetails": []
}