person-controller

Send a notification of an event to a person

Notify a person of an event with an email and/or push notification.

post/api/persons/{personId}/notify

Request

Base URL
https://api.myverifly.com
Auth
none declared
TypeScript
https://skmtc.dev/myverifly/apis/api-documentation/docs/api/persons/:personId/notify/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

personIdstring required

personId

Headers

accept-languagestring

accept-language

Request body

channelsstring[]

emailFooterstring

emailSubjectstring

notestring

paramsobject

secureContentstring

sourceIdstring

sourceNamestring

typestring

Response

Created

accessPolicyAccessPolicyMessageSourceWithCodeView

availableToDestinationboolean

codestring

createdDtmTimestampMessageSourceWithCodeView

destIdstring

destNamestring

destType'CREDENTIAL_PROVIDER' | 'PERSON' | 'SERVICE_PROVIDER' | 'SYSTEM'

emailTostring

expiringDtmTimestampMessageSourceWithCodeView

footerstring

idstring

infoMessageInfoMessageSourceWithCodeView

lastUpdatedDtmTimestampMessageSourceWithCodeView

notBeforeDtmTimestampMessageSourceWithCodeView

notestring

previousMessageIdstring

readCountinteger

secureContentstring

sourceIdstring

sourceInfoSourceInfoMessageSourceWithCodeView

sourceNamestring

sourceType'CREDENTIAL_PROVIDER' | 'PERSON' | 'SERVICE_PROVIDER' | 'SYSTEM'

subjectstring

type'ASSOCIATION_REQUEST' | 'CREDENTIAL' | 'INVITATION' | 'NOTICE' | 'PERSON_NOTIFICATION'

Changes

No recorded changes to this operation across all 1 revision of this API.