Highrise API

Custom Fields

Use the custom fields API to define, rename, and delete custom fields on an account.

List fields

GET /subject_fields.xml

Return all fields used in the account.

Response

Status: 200 OK

<subject-fields type="array">
  <subject-field>
    <id type="integer"></id>
    <label></label>
  </subject-field>
  ...
</subject-fields>

Define a field

POST /subject_fields.xml

Defines a new custom field on the account.

Request

<subject-field><label>#{label}</label></subject-field>

Response

Status: 201 Created
Location: /subject_fields/#{new_id}.xml

<subject-field>
  <id type="integer"></id>
  <label></label>
</subject-field>

Rename a field

PUT /subject_fields/#{id}.xml

Rename a field on this account.

Request

<subject-field><id>#{id}</id><label>#{label}</label></subject-field>

Response

Status: 200 OK

Remove field

DELETE /subject_fields/#{id}.xml

Removes a custom field from the account.

Response

Status: 200 OK