Skip to content

shareSavedSearch

POST
Use dark colors for code blocksCopy
1
/{orgId}/{itemId}/searches/{searchId}/shareWith
Share a saved search

Update the list of groups a saved search is shared with by specifying the updated list in the json body. The adminAdvanced privilege is required.

Share Saved Search Parameters:

ParameterDescriptionData Type
groupIdsRequired. Defines the Group Ids that the saved search will be shared with.Array[String]

Query parameters

NameTypeRequired
tokenstring¦null

Body parameters

Supported content types: application/json

Type: groupIds

The list of groups to share the saved search.

NameTypeRequired
groupIds[string]

Path parameters

NameTypeRequired
searchIdstring
orgIdstring
itemIdstring

Response status

StatusMeaningDescriptionSchema
200OK

success

Success
400Bad Request

Error

WorkflowExceptionDTO

Examples

Request

Use dark colors for code blocksCopy
1
2
3
4
5
# You can also use wget
curl -X POST /{orgId}/{itemId}/searches/{searchId}/shareWith \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer <YOUR_TOKEN>' \
  --data '{"groupIds":["string"]}'

Response

Use dark colors for code blocksCopy
1
2
3
{
  "success": true
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.