Update Custom Table for Contact

Updates a custom table for the specified contact.

Resource Information

Scopecontacts

Deprecated scope name:   update_contact_customtables

App TypeAll
Authorization TypeAccess token
URI /v4/contacts/{contactId}/customTables?lang={lang}
HTTP MethodPUT
Automation Version(s)7.3.3.4

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
contactIdlongYes Get All Contacts The unique ID associated with the contact.7.3.3.4
langStringNo Indicates the language applied.7.3.3.4
[]arrayYes Array containing the custom table(s).7.3.3.4
idstringNo The unique identifier for the custom table to be modified or deleted.7.3.3.4
rows[]rows{}Yes Contains the table rows.7.3.3.4
rows.actionstringYesadd | update | delete Specifies whether to add, update, or delete the custom table row.7.3.2
rows.fieldsrows.fields{}No Contains fields and their attributes. Required only if adding or modifying a row.7.3.3.4
rows.fields.<customType>stringNo 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".
7.3.3.4
rows.idstringNo The unique identifier for the custom field. Required only if modifying or deleting a row.7.3.3.4

Response Information

FieldTypeDescriptionAutomation Version
result[]result{} 7.3.3.4
result.codestringA code identifying an associated item7.3.3.4
result.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.3.4
result.isSuccessbooleanIndicates whether or not the operation on the item is successful. 7.3.3.4
result.messagestringA text message related to the operation.7.3.3.4
statusintegerThe record status.7.3.3.4