Skip to content

Document email_verified on the contact object - #678

Open
dan0505 wants to merge 6 commits into
mainfrom
document-contact-email-verified-response
Open

dan0505 wants to merge 6 commits into
mainfrom
document-contact-email-verified-response

Conversation

@dan0505

@dan0505 dan0505 commented Sep 23, 2026

Copy link
Copy Markdown
Contributor

Why?

The contact object now tells you whether a contact's email address has been verified. You could already set this when creating or updating a contact, but nothing gave the value back, so there was no way to read the current state.

How?

Adds the field to the contact schema and to the response examples that spell out the whole contact object. It is on the Preview description only, since no released version returns it yet.

Notes for reviewers

The API change this documents has not shipped yet, so please don't merge ahead of it.

Generated with Claude Code

The contact object now returns whether its email address has been
verified. The field was already accepted on contact create and update.
Only examples that spell out the whole contact object, and the visitor
convert endpoint, which returns a contact rather than a visitor.
The contact object returns email_verified on Preview only, so the released
2.16 description should not advertise it.
"Has been verified" read as though we had checked the address ourselves. It
can equally be your own assertion, so the description now names both
origins and says the field does not distinguish them.
Mail arriving from an address marks it verified on its own, so the previous
wording overstated the evidence by tying it to sender domain
authentication. Also names file import, and drops the signed-identity
routes, which are not available to every workspace.
The previous wording described routes that are not reachable today, which
read as behaviour rather than intent.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant