Collection Points
Update Collection Point Status
Use this API to update the status of a Collection Point.
🗒 Things to Know
- To disable the Collection Point, set the value query parameter to true. All versions of the Collection Point will be disabled from ingesting receipts.
- To enable the Collection Point, set the value query parameter to false. The previous status of the Collection Point will be restored.
- The following Collection Point types cannot be disabled: ADMIN_UPDATE and NOTIFICATION_OPT_OUT.
put/api/consentmanager/v1/collectionpoints/{collectionpointId}/disable
Path parameters
collectionpointIdstring uuid required
Example:123e4567-e89b-12d3-a456-426614174000
The unique identifier of the Collection Point to enable/disable.
Query parameters
valueboolean
Example:true
Set to true to disable the Collection Point, or false to enable it.
Response
OK - Collection Point status updated successfully.