Conversation
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.
…l-verified-response
Correct the request-side semantics on the create and update contact request schemas for the 2.16 and Preview specs, and correct the Preview-only response field description on the contact schema to drop the CSV-import and inbound-mail claims that no longer apply. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01X52yaGBxmKCTMiXQG8rBKe
Describe the request and response fields in terms of proving ownership of an email address rather than a bare verified/unverified state, with a worked request-body example. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01X52yaGBxmKCTMiXQG8rBKe
The convert visitor endpoint does not return the field, so its example should not show it. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01X52yaGBxmKCTMiXQG8rBKe
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01X52yaGBxmKCTMiXQG8rBKe
…anges Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01X52yaGBxmKCTMiXQG8rBKe
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01X52yaGBxmKCTMiXQG8rBKe
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why?
Callers can set
email_verifiedwhen creating or updating a contact, but the descriptions never said what "verified" means or when to send it, and nothing returned the value. The Preview version now returns it, so the read side needs documenting and the write-side text needs to describe the same meaning.How?
Rewrites the
email_verifiedrequest descriptions on 2.16 and Preview around proof of ownership, with an example and a warning against marking unproven addresses. Adds the field to the Preview contact schema and to the response examples that spell out the whole contact object.Notes for reviewers
The 2.16 edits are description text only; no schema or response shape changes on a released version. The API behaviour this documents is live.
Generated with Claude Code