Document that the S2S/Transition API "type" field is case-sensitive (DOC-2298) - #460
Open
BrindaaRC wants to merge 1 commit into
Open
Document that the S2S/Transition API "type" field is case-sensitive (DOC-2298)#460BrindaaRC wants to merge 1 commit into
BrindaaRC wants to merge 1 commit into
Conversation
…DOC-2298) Clarify in the Data API reference that each element's "type" field is case-sensitive and must be lowercase (customer, event, or device); a value with different casing, such as "Customer", is not accepted. Add a troubleshooting note in the Data API overview so users check the "type" casing when records are not processed. Addresses DOC-2298 (source SUP-9022). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
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.
What changed
Clarifies in the Data API reference that each element's
typefield is case-sensitive and must be lowercase (customer,event, ordevice).typefield descriptions for the customer, event, and device schemas to state the value must be lowercase and that a different-cased value (e.g.Customer) is not accepted.<Warning>in the Request Body section: if records are not processed and no user/event/device is created, verify thetypevalue is lowercase.Why
Support ticket SUP-9022: a client sent a capitalized
typevalue and the data was not processed, with no obvious cause. The reference did not make the lowercase requirement or the failure symptom clear.Reviewer notes
[customer],[event],[device]) and existing case-sensitivity notes.AttributeErrorexample while the source ticket described a silent drop — that precise behavior is left to a separate eng confirmation and does not affect this doc's accuracy.🤖 Generated with Claude Code