API ReferencePlatform API

Api Pulses Behaviors Custom Create

POST handler with superadmin-only field protection.

Strips superadmin-only fields from non-superadmin requests before delegating to OrganizationInjectionMixin.post() for org injection.

Authentication

AuthorizationBearer
JWT access token or Respan API key

Request

This endpoint expects an object.
namestringRequired1-128 characters
descriptionstringOptional
polarityenumOptional
  • positive - Positive
  • negative - Negative
  • neutral - Neutral
exampleslist of objectsOptional

Response

idstringRead-only
namestring<=128 characters
statusenum
  • draft - Draft
  • training - Training
  • ready - Ready
  • failed - Failed
created_atdatetimeRead-only
updated_atdatetimeRead-only
descriptionstring
polarityenum
  • positive - Positive
  • negative - Negative
  • neutral - Neutral
exampleslist of objects