Sign in

v1

latestSwagger 2.02026-07-134026156.7 KB
Data Requests

Create a new event for emailing a signee a request for signature

Records user notification events for data requests. Use this to create an audit trail showing when and how users were notified about data request forms. Supports email, SMS, and other notification types. Records the notification time for compliance tracking.

See also:

post/data_requests/{data_request_id}/events

Path parameters

data_request_idstring required

Request body

event_type'send_request' | 'view_request' | 'accepted_terms' | 'decline_request' | 'sign_request' | 'all_completed' required
message_recipientstring nullable
message_type'email' | 'sms' | 'fax' | 'mail' | 'slack' | 'msteams' | 'discord' | 'telegram' | 'whatsapp' nullable
occurred_atstring nullable

Example request

{
  "event_type": "send_request",
  "message_type": "email",
  "message_recipient": "test@test.com"
}

Response

event created

status'success' | 'error' required
errorsstring[]