outcomes

Update an outcome

Changed on

Update an existing outcome.

put/outcome/{id}/

Request

  • Base URL
    https://api.close.com/api/v1
  • URL
    https://api.close.com/api/v1/outcome/{id}/
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://app.close.com/oauth2/authorize/
      Token URL: https://api.close.com/oauth2/token/

Path parameters

idstring required

Request body

applies_toOutcomeAppliesTo[] nullable

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

descriptionstring nullable

Explain what the outcome means and when it should be used.

namestring nullable

Displayed to users wherever outcomes can be selected.

type'vm-dropped' | 'custom'

Response

Successful response

applies_toOutcomeAppliesTo[] required
created_bystring nullable required
date_createdstring date-time required
date_updatedstring date-time required
descriptionstring nullable required
idstring required
namestring required
organization_idstring required
type'vm-dropped' | 'custom' required
updated_bystring nullable required

Changes

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status