Skip to main content
POST
Create a consent record

Authorizations

Authorization
string
header
required

OAuth 2.0 client credentials flow. Contact timeback@trilogy.com to request credentials for your application.

Path Parameters

studentId
string<uuid>
required

Unique identifier of the student

Body

application/json

Status of the consent. Note: the platform does not produce expired automatically; a request that lapses unsigned stays pending. expired is accepted only as a createConsentRecord input. voided is written when a request is superseded (re-request, name correction, sibling grant) or the DocuSign envelope is voided.

Available options:
pending,
granted,
denied,
expired,
voided,
withdrawn
occurredAtTime
string<date-time>
required

Timestamp when the consent status change occurred

guardianId
string<uuid> | null

UUID of the parent/guardian providing consent. Nullable only for pending records where metadata.consentMethod is awaiting_guardian.

metadata
object | null

Free-form audit context. Common keys the platform reads/writes: consentMethod, docusignEnvelopeId, docusignStatus, emailConsentInitiatedAt, returnUrl, and (on voided records) supersededBy and originalEnvelopeId. Additional keys are allowed.

Response

Consent record created successfully