Skip to main content
Version: 1.0.0

Remove identifier

Information

Use this endpoint to remove an existing identifier for a business entity.

This endpoint is synchronous
The role admin is needed in order to use this endpoint
Endpoints

DELETE/v1/config/business/entity/identifier/{businessEntityIdentifierId}

Path parameters
businessEntityIdentifierIdstring (uuid) - Required



Request

DELETE /v1/config/business/entity/identifier/:businessEntityIdentifierId


curl -X 'DELETE'
'https://api.ppd.iopole.fr//v1/config/business/entity/identifier/32c9aec1-e6d6-4ddf-82a0-42dfa29268f8'
-H 'accept: application/json'
-H 'Authorization: Bearer ${TOKEN}'

Response

Status: 200 - application/json

Description: Removed businessEntityIdentifierId

Schema:

  • type: enum
    The type of the response object.
  • id: string
    The unique identifier for the created element.

Examples:

{
  "type": "BUSINESS_ENTITY_IDENTIFIER",
  "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}

Status: 401

Description: Unauthorized - Authentication is required and has failed or has not yet been provided.

Status: 403

Description: Forbidden - The server understood the request, but it refuses to authorize it. Note: This endpoint requires an admin account.