Update a France PID directory entry
PATCH/api/v1/companies/:company_id/france/pid/entries/:id
Enqueues a change request to change the end-of-validity date of a directory entry. The entry must belong to the specified company. effective_to_on (DT-7-3-2) is the only attribute this API transmits to the directory: sending any other attribute is rejected with 422 and no change request is created. Annexe 3 V1.8 DG-7 also allows the receiving-platform matricule (DT-7-6) to be changed on a line that is not yet in force, which this API does not yet support. To change an addressing attribute, end the current line and register a new one; to mask a line that is not yet in force, use DELETE.
Request
Responses
- 202
- 401
- 403
- 404
- 422
The change request to update the directory entry was accepted and enqueued; the actual directory operation completes asynchronously. The response returns the change request ID, not the entry itself. Once the change request has been processed, a read of the entry reports the new effective_to_on.
The request did not include a valid OAuth 2.0 bearer token.
Either the OAuth client lacks the write scope, or the directory feature is not enabled for this workspace.
No entry exists with this ID for the specified company, or the company belongs to a workspace the authenticated OAuth client cannot access.
The request tried to change an attribute this API does not transmit to the directory, or the new end-of-validity date failed validation. The response body's details object names the offending attributes; no change request is created.