diff --git a/_site/sections/custom_fields.md b/_site/sections/custom_fields.md new file mode 100644 index 0000000..9b4c11b --- /dev/null +++ b/_site/sections/custom_fields.md @@ -0,0 +1,144 @@ +Party & Deal Custom Fields +============= + +Use the custom fields API to define, rename, and delete party and deal custom fields on an account. + +For the full XML representation of custom fields, [check out the data reference](https://github.com/basecamp/highrise-api/blob/master/sections/data_reference.md#custom_field). + + +Get party custom fields +----------------- + +* `GET /subject_fields.xml?type=party` return all fields used in the account. + +**Response:** + +``` xml + + + + + party + + ... + +``` + +Create party custom field +------------------- + +* `POST /subject_fields.xml` defines a new custom field on the account. + +**Request:** + +``` xml + +``` + +**Response:** + + Status: 201 Created + Location: /subject_fields/#{new_id}.xml + + + + + party + + + +Update party custom field +------------------- + +* `PUT /subject_fields/#{id}.xml` renames a field on this account. + +**Request:** + +``` xml +#{id}party +``` + +**Response:** + + Status: 200 OK + + +Destroy party custom field +-------------------- + +* `DELETE /subject_fields/#{id}.xml` removes a party custom field from the account. + +**Response:** + + Status: 200 OK + + +Get deal custom fields +----------------- + +* `GET /subject_fields.xml?type=deal` return all deal fields used in the account. + +**Response:** + +``` xml + + + + + deal + + ... + +``` + +GET /subject_fields.xml?type=deal + + +Create deal custom field +------------------- + +At the moment, you cannot create deal custom fields via the API. Only retrieve, update, and destroy. + +Update deal custom field +------------------- + +* `PUT /subject_fields/#{id}.xml` renames a field on this account. + +**Request:** + +``` xml +#{id} +``` + +**Response:** + + Status: 200 OK + + +Destroy deal custom field +-------------------- + +* `DELETE /subject_fields/#{id}.xml` removes a deal custom field from the account. + +**Response:** + + Status: 200 OK + +Get all custom fields +----------------- + +* `GET /subject_fields.xml?type=all` return all deal fields used in the account. + +**Response:** + +``` xml + + + + + party or deal + + ... + +``` + diff --git a/sections/custom_fields.md b/sections/custom_fields.md deleted file mode 100644 index 3f8f44d..0000000 --- a/sections/custom_fields.md +++ /dev/null @@ -1,71 +0,0 @@ -Custom Fields -============= - -Use the custom fields API to define, rename, and delete custom fields on an account. - -For the full XML representation of custom fields, [check out the data reference](https://github.com/basecamp/highrise-api/blob/master/sections/data_reference.md#custom_field). - - -Get custom fields ------------------ - -* `GET /subject_fields.xml` return all fields used in the account. - -**Response:** - -``` xml - - - - - - ... - -``` - -Create custom field -------------------- - -* `POST /subject_fields.xml` defines a new custom field on the account. - -**Request:** - -``` xml - -``` - -**Response:** - - Status: 201 Created - Location: /subject_fields/#{new_id}.xml - - - - - - - -Update custom field -------------------- - -* `PUT /subject_fields/#{id}.xml` rename a field on this account. - -**Request:** - -``` xml -#{id} -``` - -**Response:** - - Status: 200 OK - - -Destroy custom field --------------------- - -* `DELETE /subject_fields/#{id}.xml` removes a custom field from the account. - -**Response:** - - Status: 200 OK diff --git a/sections/data_reference.md b/sections/data_reference.md index 6d58b83..3ca5450 100644 --- a/sections/data_reference.md +++ b/sections/data_reference.md @@ -124,7 +124,7 @@ Contact data for person and company ``` -Custom fields +Party and Deal Custom fields ------------- ``` xml @@ -132,6 +132,7 @@ Custom fields 3 Chicago + party or deal 1 Sales Region