Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
branch: master
@qrush qrush
72 lines (45 sloc) 1.338 kB

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.

Get custom fields

  • GET /subject_fields.xml return all fields used in the account.

Response:

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

Create custom 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>

Update custom 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

Destroy custom field

  • DELETE /subject_fields/#{id}.xml removes a custom field from the account.

Response:

Status: 200 OK
Jump to Line
Something went wrong with that request. Please try again.