API Reference

Create an Enrollment event

post
https://api.derapi.com/enrollments//events

Record an event for an existing Enrollment record.

For example, use type of unenrolled to indicate a customer has unenrolled from the Program.

Path Params
string
required

The ID of the Enrollment which you're addressing

Body Params

Records an Enrollment event.

Only certain operator event types are allowed to be created via this endpoint.

string
enum
required

The type of enrollment event to be created

Show Details
approvedRecord operator approval
rejectedRecord operator rejection, without the ability to resubmit
resubmitrequestedRequest customer resubmit enrollment application
unenrolledRecord operator unenrollment
Allowed:
string
length ≤ 500

Reason for the event; only accepted for rejected, resubmitrequested, and unenrolled types

Responses
204

No content

Updated 11 days ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/problem+json

Updated 11 days ago