The following macros are not currently supported in the header:
  • style

Profiles

UNDER DEVELOPMENT

The following endpoints can be used to access and manipulate a given object's profile value. Profile values are essentially additional fields you can dynamically apply to different object types. Profile fields are available across many record types. They allow you to configure custom fields which will apply to all records within that module - such as all your prospect types, not just one of them.

We currently support the following object types:

  1. Company
  2. Contact
  3. Affiliation
  4. Prospect
  5. Issue
  6. Milestone

Table of available extension endpoints.  

TYPERESOURCEDESCRIPTION
GET/:object_type/:object_id/profiles/values

Returns an array of profile values for the given object. For example, to get an Issue's profile values that has an id of 200 in XML format, you would call

GET /api/v0/issues/200/profiles/values.xml

More details about this endpoint can be found here.

PUT/:object_type/:object_id/profiles/values/:profile_value_idUpdate a given profile value and return its updated contents. For example, to update an Issue's profile value with profile value id 300 and Issue id 200, and to return the updated profile details in JSON, you would call

PUT /api/v0/issues/200/profiles/values/300.json

More details about this endpoint can be found here.

GET/:object_type/profiles/fields

Returns an array of profile fields for the given type of object. For example, to get an Issue's profile fields that has an id of 200 in XML format, you would call

GET /api/v0/issues/profiles/fields.xml

More details about this endpoint can be found here.

POST/:object_type/:object_id/profiles/fields/:profile_field_idCreate a profile value for a given object and return its contents. For example, to update an Issue's profile value with profile field id 300 and Issue id 200, and to return the updated profile details in JSON, you would call

POST/api/v0/issues/200/profiles/fields/300.json

More details about this endpoint can be found here.