Action Descriptions

API Action description is used to generate API success / fail messages after API executes.

Untitled

How to write good descriptions

Best descriptions complete the prompt "This action will ____"

Good examples

Action DescriptionGenerated message (Success)Generated message (Failure)
✅ Submit an employee referralI've successfully submitted the employee referral.I was unable to submit the employee referral.
✅ Submit a referral in PurpleHireI've successfully submitted the referral in PurpleHire.I was unable to submit the referral in PurpleHire.
✅ Refer an employee for EngineeringI've successfully referred an employee for Engineering.I was unable to refer the employee for Engineering.

Bad examples

Action DescriptionGenerated message (Success)Generated message (Failure)
❌ referral submission APII've successfully submitted the referral API.I was unable to submit the referral API.
❌ action to submit a referralI've successfully submitted the action to submit a referral.I was unable to complete the action to submit a referral.
❌ API that submits referralI've successfully completed the API to submit referral.I was unable to complete the API to submit referral.

Describing your action this way best helps our language model understand it & generate the best success / fail messages.