Login

Client

Delete client

DELETE /api/v1/headless/client/{identifier}

Use this endpoint to delete all objects associated with a clientIdentifier.

Path parameters

FieldDescriptionOptions
identifierClient identifier N/A

Responses

CodeDescription
200All related objects and creators deleted

Delete user

DELETE /api/v1/headless/user/{identifier}

Use this endpoint to delete a user by their identifier. You can choose what to do with any courses associated with this identifier.

Path parameters

FieldDescriptionOptions
identifierIdentifier N/A

Body properties

FieldTypeDescriptionRequiredOptions
actionstringHow to handle courses allocated to this userNoreallocate  delete  ignore 
reallocateTostringIf action is reallocate, the identifier to reallocate toNo N/A

Responses

CodeDescription
200Success