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.
Path Params
uuid
required

The unique identifier of the Collection Point to enable/disable.

Query Params
boolean
Defaults to true

Set to true to disable the Collection Point, or false to enable it.

Responses
200

OK - Collection Point status updated successfully.

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

Language
Credentials
OAuth2
Missing 1 required scope
URL
LoadingLoading…
Response
Choose an example:
*/*