Mask (delete) a France PID directory entry

DELETE 
/api/v1/companies/:company_id/france/pid/entries/:id

Enqueues a masking change request for the directory entry. The entry must belong to the specified company. Masking only applies to a line that is not yet in force (Annexe 3 V1.8 DT-7-2, Annexe 7 V1.9 G1.85); to retire a line already in force, PATCH its effective_to_on instead.

Request

Responses

202

The change request to mask the directory entry was accepted and enqueued. Masking removes the entry from active publication in the national directory without erasing its history: once the change request has been processed the entry no longer appears in the company's entry list, and a read of the entry by ID reports "masked": true. The response returns the change request ID, not the entry itself.

401

The request did not include a valid OAuth 2.0 bearer token.

403

Either the OAuth client lacks the destroy or write scope, or the directory feature is not enabled for this workspace.

404

No entry exists with this ID for the specified company, or the company belongs to a workspace the authenticated OAuth client cannot access.