Docs

Update Organization Notification Settings

puthttps://app.fossa.com/api/organizations/{id}/settings/projects/notifications

Update notification settings for an organization

Path parameters

idintegerrequired

Request body · application/json

notificationDefaultEnabledbooleanrequired

the on/off status of project notifications

notificationDefaultSlackScanbooleanrequired

the on/off status of slack notifications for scans

notificationDefaultApiWebhookScanbooleanrequired

the on/off status of API webhook notifications for scans

notificationDefaultEmailScanUsersnumber[]required
notificationDefaultEmailScanUserTypeenumrequired

The type of users to email for scan notifications. Each option represents a different set of users: - current: Only the current user will receive scan notifications. - all: All users will receive scan notifications. - custom: Custom set of users will receive scan notifications.

currentallcustom

Responses

204No content
401Unauthorized
uuidstring

Unique identifier associated with the error

codeinteger

fossa specific error code

messagestring

message associated with this error

namestring

name of the error

httpStatusCodeinteger

http status code number

403Forbidden
uuidstring

Unique identifier associated with the error

codeinteger

fossa specific error code

messagestring

message associated with this error

namestring

name of the error

httpStatusCodeinteger

http status code number

404NotFound
uuidstring

Unique identifier associated with the error

codeinteger

fossa specific error code

messagestring

message associated with this error

namestring

name of the error

httpStatusCodeinteger

http status code number

422Unprocessable Entity
uuidstring

Unique identifier associated with the error

codeinteger

fossa specific error code

messagestring

message associated with this error

namestring

name of the error

httpStatusCodeinteger

http status code number

Try this endpoint

Build a request and run it against app.fossa.com.

Bearer

Stored in this browser for 24 hours. Try It uses a docs proxy for CORS and does not store tokens server-side.

PUT https://app.fossa.com/api/organizations/1/settings/projects/notifications
curl --request PUT \  --url 'https://app.fossa.com/api/organizations/1/settings/projects/notifications' \  --header 'accept: application/json' \  --header 'authorization: Bearer YOUR_API_TOKEN' \  --header 'content-type: application/json' \  --data '{  "notificationDefaultEnabled": true,  "notificationDefaultSlackScan": true,  "notificationDefaultApiWebhookScan": false,  "notificationDefaultEmailScanUsers": [    1,    2  ],  "notificationDefaultEmailScanUserType": "all"}'

Real request. Mutating methods can change data.

Click Try It to run a request and see the response here.
Enter a Bearer token before running this request.

Path params

idintegerrequired
application/json
← All Organization Settings endpoints