Create an outcome

View as Markdown
Create a new outcome for the organization.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:)>.

OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
namestringRequired
Displayed to users wherever outcomes can be selected.
descriptionstring or nullOptional
Explain what the outcome means and when it should be used.
typeenumOptional

Set to vm-dropped if this outcome should be automatically set on calls whenever a team member performs a Voicemail Drop. Otherwise, leave empty or explicitly set to custom (default).

Allowed values:
applies_tolist of enums or nullOptionalDeprecated

Deprecated. This field will be derived from type in a future update: custom applies to calls and meetings, vm-dropped applies to calls only.

Allowed values:

Response

Successful response
applies_tolist of enums
Allowed values:
created_bystring or null
date_createddatetime
date_updateddatetime
descriptionstring or null
idstring
namestring
organization_idstring
typeenum
Allowed values:
updated_bystring or null

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error