Skip to navigation

Deactivate Peppol for the organization

Deregisters the participant at the Access Point and disables sending/receiving. The configuration row is kept, so re-activation re-registers without losing settings.

Authentication

AuthorizationBearer

API Key authentication. Use sk_live_* for production or sk_test_* for testing.

Request

This endpoint expects an object.
environmentenumOptionalDefaults to production

Peppol settings scope to use (which provider config + API key)

Allowed values:

Response

Registration state after deactivation
successboolean
settingsobject or null

Registration lifecycle state (null when nothing is configured)

errorCodestringOptional
errorMessagestringOptional

Errors

400
Bad Request Error
404
Not Found Error
501
Not Implemented Error
502
Bad Gateway Error