Skip to content

Commit 7df61c1

Browse files
authored
Merge pull request #5464 from segmentio/lizkane222-patch-35
Update index.md Added Troubleshooting section Update Schema Settings …
2 parents 967712b + 73fc06b commit 7df61c1

File tree

1 file changed

+28
-1
lines changed

1 file changed

+28
-1
lines changed

src/api/public-api/index.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Within seconds, GitHub scans each commit in public repositories for Public API t
3939

4040
Learn more about [GitHub's secret scanning program](https://docs.github.com/en/developers/overview/secret-scanning-partner-program){:target="_blank"}.
4141

42-
### Frequently Asked Questions
42+
## FAQs
4343
#### What should I do if I see a notification that my token was exposed?
4444
In most cases, identifying and revoking an exposed token takes seconds. Segment recommends you check the [audit trail](/docs/segment-app/iam/audit-trail/) to ensure no unauthorized actions were taken with the token.
4545

@@ -57,3 +57,30 @@ If you see a CORS error, this means you're attempting to make a request to the P
5757

5858
#### What User Role / Workspace permissions are required to generate Public API tokens?
5959
Only [users that have a `Workspace Owner` role](https://segment.com/docs/segment-app/iam/roles/#global-roles) can create Public API Tokens.
60+
61+
## Troubleshooting
62+
#### The `Update Schema Settings in Source` endpoint returns error for field `forwardingViolationsTo` and `forwardingBlockedEventsTo`
63+
When you don't have a source to forward violations or blocked events to, then exclude the fields `forwardingViolationsTo` or `forwardingBlockedEventsTo` entirely from the request and the setting will be disabled.
64+
65+
`PATCH` endpoint : `https://api.segmentapis.com/sources/{sourceId}/settings`
66+
```
67+
{
68+
"group": {
69+
"allowTraitsOnViolations": false,
70+
"allowUnplannedTraits": false,
71+
"commonEventOnViolations": "ALLOW"
72+
},
73+
"identify": {
74+
"allowTraitsOnViolations": true,
75+
"allowUnplannedTraits": true,
76+
"commonEventOnViolations": "Block"
77+
},
78+
"track": {
79+
"allowEventOnViolations": false,
80+
"allowPropertiesOnViolations": false,
81+
"allowUnplannedEventProperties": false,
82+
"allowUnplannedEvents": false,
83+
"commonEventOnViolations": "OMIT_PROPERTIES"
84+
}
85+
}
86+
```

0 commit comments

Comments
 (0)