Skip to content

Commit 44539f1

Browse files
authored
Update index.md Added Troubleshooting section Update Schema Settings in Source
1 parent c8520b2 commit 44539f1

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

src/api/public-api/index.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -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+
#### `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)