Update Record Custom Tables

Updates the custom tables for the specified record contact. The request body is an array of custom tables, each with the custom table id and an array of rows. Use this API to add, update and delete rows from an existing custom table. (Custom tables are defined in Civic Platform.) Note that the modified custom table data only applies to the transactional record contact, not the reference contact.

Resource Information


Deprecated scope name:   update_record_contact_customtables

App Type Agency
Authorization Type Access token
URI /v4/records/{recordId}/contacts/{contactId}/customTables?lang={lang}
Automation Version(s) 8.0.3

Request Information

Field or Parameter Type Required Values Description Automation Version
fields string No   Comma-delimited names of fields to be returned in the response. Note: Field names are case-sensitive and only first-level fields are supported. Invalid field names are ignored. 8.0.3
lang String No   Indicates the language applied. 8.0.3
recordId string Yes Get All Records Search Records Get My Records A URI query parameter specifying the unique ID associated with a record. 8.0.3
contactId long Yes Get All Contacts A URI query parameter specifying the unique ID associated with the record contact. 8.0.3
[] array Yes   Request body array containing the custom table id(s) and corresponding rows to be added, updated, or deleted. 8.0.3
id string Yes   The unique identifier for the custom table to be modified or added. 8.0.3
rows[] rows{} Yes   Contains the table rows. 8.0.3
rows.action string Yes add | update | delete  Specifies whether to add, update, or delete the custom table row. 8.0.3
rows.fields rows.fields{} Yes   Contains fields and their attributes. Required only if adding or modifying a row. 8.0.3
rows.fields.<customType> string Yes   A custom field name and value pair. For example in JSON, "My Custom Field": "My Custom Value". The custom field name and its data type are defined in Automation custom forms or custom tables.
  • For a Text field, the maximum length is 256.
  • For a Number field, any numeric form is allowed, including negative numbers.
  • For a Date field, the format is MM/dd/yyyy.
  • For a Time field, the format is hh:mm.
  • For a TextArea field, the maximum length is 4000 characters, and allows line return characters.
  • For a DropdownList field, the dropdown list values are in the options[] array.
  • For a CheckBox field, the (case-sensitive) valid values are "UNCHECKED" and "CHECKED".
  • For a Radio(Y/N) field, the(case-sensitive) valid values are "Yes" and "No".
rows.id string Yes   The unique identifier for the custom field. Required only if modifying or deleting a row. 8.0.3


Sample Request Head

PUT https://apis.accela.com/v4/records/15CAP-00000-0002Q/contacts/61419743/customTables

Sample Request Body

      "id": "Emergency Contacts",
      "rows": [
          "fields": {
            "Name": "Jane Smith",
            "Relationship": "Spouse",
            "Best Phone Number": "(925) 656-0981"
          "action": "add"
          "fields": {
            "Name": "Greg McCall",
            "Relationship": "Friend",
            "Best Phone Number": "(510) 558-6789"
          "id": "1",
          "action": "update"
          "id": "2",
          "action": "delete"

Response Information

Field Type Description Automation Version
result[] result{}   8.0.3
result.code string A code identifying an associated item 8.0.3
result.id string The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 8.0.3
result.isSuccess boolean Indicates whether or not the operation on the item is successful. 8.0.3
result.message string A text message related to the operation. 8.0.3
status integer The return status. 8.0.3


Sample Response Body

    "status": 200,
    "result": [
        "id": "Emergency Contacts",
        "isSuccess": true