REST API - Contact Fields

Version 2

    The REST API provides access to create, retrieve, update and delete contact fields.

     

    Accessing Contact Fields

    • GET  /assets/contact/field/{id}?depth={depth}

     

    Response

    The response for this call looks as follows :

     

    {
      "type": "ContactField",
      "id": "100001",
      "createdAt": "-2208970800",
      "depth": "complete",
      "name": "Email Address",
      "updatedAt": "1351007197",
      "updatedBy": "226",
      "dataType": "text",
      "displayType": "text",
      "internalName": "C_EmailAddress",
      "isReadOnly": "false",
      "isRequired": "false",
      "isStandard": "true",
      "updateType": "always"
    }
     

     

    Properties

     

    Name

    Type

    Description

    Notes

    Validations

    type"ContactField"
    updateTypeRuleTypeEnumRequirement
    accessedAtintegerDateRequirement
    checkedValuestring
    createdAtintegerReadOnlyDateRequirement
    createdByintegerReadOnlyIdRequirement
    currentStatusstring
    dataTypeFieldDataTypeEnumRequirement
    defaultValuestringThe default value for the field
    depthRequestDepthEnumRequirement
    descriptionstring
    displayTypeFieldDisplayTypeEnumRequirement
    folderIdintegerIdRequirement
    idintegerThe unique identifier for the fieldIdRequirement
    internalNamestring
    isReadOnlybooleanIdentifies whether the field is read onlyBooleanRequirement
    isRequiredbooleanIdentifies whether the field is requiredBooleanRequirement
    isStandardbooleanBooleanRequirement
    namestring
    optionListIdintegerIdRequirement
    outputFormatIdintegerIdRequirement
    permissionsInstancePermissionsEnumRequirement
    scheduledForintegerDateRequirement
    sourceTemplateIdstring
    uncheckedValuestring
    updatedAtintegerReadOnlyDateRequirement
    updatedByintegerReadOnlyIdRequirement 

     

    Field Data Types

    • date
    • largeText
    • number
    • numeric
    • text

     

    Field Display Types

    • checkbox
    • hidden
    • multiselect
    • radio
    • singleSelect
    • text
    • textArea

     

    Related Operations

    • POST :  /assets/contact/field
    • PUT :  /assets/contact/field/{id}
    • DELETE :  /assets/contact/field/{id}
    • GET (list) :  /assets/contact/fields?search={searchTerm}&page={page}&count={count}&orderBy={orderBy}