GEgetaptly
Contacts

Initiate contact email verification

Looks up an email address against your org's contact database. If a match is found, generates a cryptographically strong 6-digit code, sends it to the address, and returns a requestId and verifyUrl to complete the verification.

The code expires after 10 minutes and can only be used once.

post/api/contacts/verify-email

Request

Request body

emailstring required

The email address to verify.

emailSubjectstring

Subject line for the verification email. Defaults to "Your verification code".

replyTostring

Reply-To address for the verification email.

emailHtmlstring

Custom HTML body for the verification email. Supports two placeholders: {{ verificationCode }} — replaced with the 6-digit code. {{ expirationTime }} — replaced with the expiry duration (e.g. "10 minutes").

Response

Verification initiated — code sent to the email address.

requestIdstring

Opaque ID used to complete the verification.

verifyUrlstring

API path to POST the code to (relative URL).

Changes

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