post https://api.merits.com/v2/merits/send
Sends a Merit to a recipient and returns the Merit.
Either recipientEmail or recipientMemberId must be provided, but not both. Note, the documentation has recipientEmail marked as required, as this is by far the primary method used to send merits. If your integration will leverage the recipientMemberId instead, recipientEmail can be ignored.
200 OK Response Schema
Key Name | Value Type | Description |
---|---|---|
id | ID | The Merit ID |
sendDateTime | date | The DateTime the Merit was sent to the recipient |
active | boolean | The active/inactive status of the merit |
status | MeritStatus | The status of the merit, e.g. forfeited, pending, accepted, etc |
meritTemplateId | ID | The ID of the MeritTemplate for this Merit |
meritTemplateTitle | string | The Title of the MeritTemplate for this Merit |
email | string | The email this Merit was sent to. Read more about Merit email vs Member email and privacy |
name | Name | The first and last name this Merit was sent to. Read more about Merit name vs Member name and privacy |
fieldValues | Array<FieldValue> | Read more about Fields and FieldValues |
recipientMember | null | The recipientMember property on a Merit will always be null at the moment it's sent since the user cannot possibly have already accepted it. |
editable | boolean | Whether the merit fields can be edited |