Custom Fields

• • • GET /api/organizations/{organization_id}/custom-fields

      • Get all organization's custom fields
      • Documentation
      • Sandbox

      Requirements

      Name	Requirement	Type	Description
      organization_id

      Status Codes

      Status Code	Description
      200	Custom fields list
      401	Unauthorized (i.e. OAuth2 authentication required)

      Input

      Requirements

      = -

      Headers

      = -

      = -

      New header

      Content

      = Set header Replaces header if set

      Request URL

      Request body

      Response Headers [Expand] [Profiler]

      Response Body [Raw]

      Curl Command Line

    • POST /api/organizations/{organization_id}/custom-fields

      • Create a new custom field
      • Documentation
      • Sandbox

      Requirements

      Name	Requirement	Type	Description
      organization_id

      Parameters

      Parameter	Type	Required?	Format	Description
      name	string	true
      customFieldType	choice	true	["choice","label","list","publications","textarea"]
      description	string	true
      position	integer	true
      settings	object (CustomFieldSettingsType)	true
      settings[visibility]	choice	true	["visible","hidden"]
      settings[editable]	choice	true	["admin","evolution","member"]
      displayTo	choice	true	["circle","role","circlerole"]
      applyTo	choice	true	["member","role"]
      options	collection	false

      Status Codes

      Status Code	Description
      201	Custom field created
      401	Unauthorized (i.e. OAuth2 authentication required)

      Input

      Requirements

      = -

      Parameters

      = Type String Boolean File Textarea -

      = Type String Boolean File Textarea -

      = Type String Boolean File Textarea -

      = Type String Boolean File Textarea -

      = Type String Boolean File Textarea -

      = Type String Boolean File Textarea -

      = Type String Boolean File Textarea -

      = Type String Boolean File Textarea -

      = Type String Boolean File Textarea -

      = Type String Boolean File Textarea -

      New parameter

      Headers

      = -

      = -

      New header

      Content

      = Set header Replaces header if set

      Request URL

      Request body

      Response Headers [Expand] [Profiler]

      Response Body [Raw]

      Curl Command Line

    • DELETE /api/organizations/{organization_id}/custom-fields/{custom_field_id}

      • Delete a given custom field by its ID.
      • Documentation
      • Sandbox

      Requirements

      Name	Requirement	Type	Description
      organization_id
      custom_field_id

      Status Codes

      Status Code	Description
      204	The custom field has been deleted.
      401	Unauthorized (i.e. OAuth2 authentication required)

      Input

      Requirements

      = -

      = -

      Headers

      = -

      = -

      New header

      Content

      = Set header Replaces header if set

      Request URL

      Request body

      Response Headers [Expand] [Profiler]

      Response Body [Raw]

      Curl Command Line

    • GET /api/organizations/{organization_id}/custom-fields/{custom_field_id}

      • Get a given custom field by its ID.
      • Documentation
      • Sandbox

      Requirements

      Name	Requirement	Type	Description
      organization_id
      custom_field_id

      Status Codes

      Status Code	Description
      200	Returns the custom fields
      401	Unauthorized (i.e. OAuth2 authentication required)

      Input

      Requirements

      = -

      = -

      Headers

      = -

      = -

      New header

      Content

      = Set header Replaces header if set

      Request URL

      Request body

      Response Headers [Expand] [Profiler]

      Response Body [Raw]

      Curl Command Line

    • PATCH /api/organizations/{organization_id}/custom-fields/{custom_field_id}

      • Updates the given custom field
      • Documentation
      • Sandbox

      Requirements

      Name	Requirement	Type	Description
      organization_id
      custom_field_id

      Parameters

      Parameter	Type	Required?	Format	Description
      name	string	false
      customFieldType	choice	false	["choice","label","list","publications","textarea"]
      description	string	false
      position	integer	false
      settings	object (CustomFieldSettingsType)	false
      settings[visibility]	choice	true	["visible","hidden"]
      settings[editable]	choice	true	["admin","evolution","member"]
      displayTo	choice	false	["circle","role","circlerole"]
      options	collection	false

      Status Codes

      Status Code	Description
      200	Custom field updated
      401	Unauthorized (i.e. OAuth2 authentication required)

      Input

      Requirements

      = -

      = -

      Parameters

      = Type String Boolean File Textarea -

      = Type String Boolean File Textarea -

      = Type String Boolean File Textarea -

      = Type String Boolean File Textarea -

      = Type String Boolean File Textarea -

      = Type String Boolean File Textarea -

      = Type String Boolean File Textarea -

      = Type String Boolean File Textarea -

      = Type String Boolean File Textarea -

      New parameter

      Headers

      = -

      = -

      New header

      Content

      = Set header Replaces header if set

      Request URL

      Request body

      Response Headers [Expand] [Profiler]

      Response Body [Raw]

      Curl Command Line