Freeze user on collection

Path: v1/hts/api/integration/freeze-user-on-collection

How to use:

To freeze a specific user on collection the ‘collectionId’ representing the collection to freeze and the email address of the user to be frozen should be provided. screenshot

Parameter List

Below table represents the parameters, data type of parameter and whether the parameter is required or not for freezing a collection.

Field	Type	Required	Usage
`collectionId`	String	Required	`"collectionId"` is used to identify the collection to consider for freezing.
`targetEmailAddress`	String	Required	Email address of the user to be frozen.

cURL command

curl --request POST \
  --url http://<dgverse-api-base-url>/v1/hts/api/integration/freeze-user-on-collection \
  --header 'Authorization: Bearer <YOUR_TOKEN>' \
  --header 'Content-Type: application/json' \
  --data '{"collectionId": "<VALUE>", "targetEmailAddress": "<VALUE>"}'

Response

A ‘200 Ok’ status means the freezing process is successful. screenshot

Error Troubleshooting

400 Bad Request: The collection provided to freeze is not associated with this account.
500 Internal Server Error: The account ID (“accountIdToFreeze”) provided to freeze is invalid.