Foundry API

<back to all web services

RemoveUserFromBlockListRequest

Requires Authentication
The following routes are available for this service:
DELETE/organisations/{Id}/blocklist
RemoveUserFromBlockListRequest Parameters:
NameParameterData TypeRequiredDescription
IdpathstringNo
UserIdquerystringNo
BlockListResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
NotificationSettingsformOrganisationNotificationSettingsNo
OrganisationNotificationSettings Parameters:
NameParameterData TypeRequiredDescription
WarningNotificationRolesformList<string>No
JobFinishedNotificationRolesformList<string>No
UserIdBlockListformList<string>No
IdformstringNo
BlockListResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
NotificationSettingsformOrganisationNotificationSettingsNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

DELETE /organisations/{Id}/blocklist HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"notificationSettings":{"warningNotificationRoles":["String"],"jobFinishedNotificationRoles":["String"],"userIdBlockList":["String"],"id":"String"}}