Commit dbdc015
Document email_verified on the contact object (#678)
* Document email_verified on the contact object
The contact object now returns whether its email address has been
verified. The field was already accepted on contact create and update.
* Show the new field in the full-shape contact response examples
Only examples that spell out the whole contact object, and the visitor
convert endpoint, which returns a contact rather than a visitor.
* Limit the response field to the Preview description
The contact object returns email_verified on Preview only, so the released
2.16 description should not advertise it.
* Say what a verified email actually means
"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.
* Correct what inbound mail proves about a verified address
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.
* Name only the routes that actually set the field
The previous wording described routes that are not reachable today, which
read as behaviour rather than intent.
* Rewrite email_verified request and response descriptions for accuracy
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
* Reframe email_verified descriptions around proof of ownership
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
* Drop email_verified from the visitor convert response example
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
* Say what omitting email_verified means on create as well as update
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01X52yaGBxmKCTMiXQG8rBKe
* Say what happens to email_verified when a verified contact's email changes
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01X52yaGBxmKCTMiXQG8rBKe
* Show email_verified in the visitor convert response example
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01X52yaGBxmKCTMiXQG8rBKe
* Simplify the email_verified request field description
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>1 parent 391a4ee commit dbdc015
2 files changed
Lines changed: 44 additions & 4 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
8891 | 8891 | | |
8892 | 8892 | | |
8893 | 8893 | | |
| 8894 | + | |
8894 | 8895 | | |
8895 | 8896 | | |
8896 | 8897 | | |
| |||
8980 | 8981 | | |
8981 | 8982 | | |
8982 | 8983 | | |
| 8984 | + | |
8983 | 8985 | | |
8984 | 8986 | | |
8985 | 8987 | | |
| |||
9174 | 9176 | | |
9175 | 9177 | | |
9176 | 9178 | | |
| 9179 | + | |
9177 | 9180 | | |
9178 | 9181 | | |
9179 | 9182 | | |
| |||
9388 | 9391 | | |
9389 | 9392 | | |
9390 | 9393 | | |
| 9394 | + | |
9391 | 9395 | | |
9392 | 9396 | | |
9393 | 9397 | | |
| |||
10027 | 10031 | | |
10028 | 10032 | | |
10029 | 10033 | | |
| 10034 | + | |
10030 | 10035 | | |
10031 | 10036 | | |
10032 | 10037 | | |
| |||
10188 | 10193 | | |
10189 | 10194 | | |
10190 | 10195 | | |
| 10196 | + | |
10191 | 10197 | | |
10192 | 10198 | | |
10193 | 10199 | | |
| |||
25988 | 25994 | | |
25989 | 25995 | | |
25990 | 25996 | | |
| 25997 | + | |
25991 | 25998 | | |
25992 | 25999 | | |
25993 | 26000 | | |
| |||
31527 | 31534 | | |
31528 | 31535 | | |
31529 | 31536 | | |
| 31537 | + | |
| 31538 | + | |
| 31539 | + | |
| 31540 | + | |
| 31541 | + | |
31530 | 31542 | | |
31531 | 31543 | | |
31532 | 31544 | | |
| |||
34920 | 34932 | | |
34921 | 34933 | | |
34922 | 34934 | | |
34923 | | - | |
| 34935 | + | |
| 34936 | + | |
| 34937 | + | |
| 34938 | + | |
| 34939 | + | |
| 34940 | + | |
| 34941 | + | |
| 34942 | + | |
34924 | 34943 | | |
34925 | 34944 | | |
34926 | 34945 | | |
| |||
43196 | 43215 | | |
43197 | 43216 | | |
43198 | 43217 | | |
43199 | | - | |
| 43218 | + | |
| 43219 | + | |
| 43220 | + | |
| 43221 | + | |
| 43222 | + | |
| 43223 | + | |
| 43224 | + | |
| 43225 | + | |
43200 | 43226 | | |
43201 | 43227 | | |
43202 | 43228 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
28791 | 28791 | | |
28792 | 28792 | | |
28793 | 28793 | | |
28794 | | - | |
| 28794 | + | |
| 28795 | + | |
| 28796 | + | |
| 28797 | + | |
| 28798 | + | |
| 28799 | + | |
| 28800 | + | |
| 28801 | + | |
28795 | 28802 | | |
28796 | 28803 | | |
28797 | 28804 | | |
| |||
35530 | 35537 | | |
35531 | 35538 | | |
35532 | 35539 | | |
35533 | | - | |
| 35540 | + | |
| 35541 | + | |
| 35542 | + | |
| 35543 | + | |
| 35544 | + | |
| 35545 | + | |
| 35546 | + | |
| 35547 | + | |
35534 | 35548 | | |
35535 | 35549 | | |
35536 | 35550 | | |
| |||
0 commit comments