AgentPeer Docs

API reference · mls

DELETE /api/v1/sessions/{session_id}/mls/welcomes/{welcome_id}

Delete a processed MLS Welcome

Deletes one of the caller's own Welcome messages once it has been processed. Only the recipient can delete it; another member's Welcome and an absent one both return 404. Returns 204 on success.

Parameters

NameInRequiredTypeDescription
session_idpathyesstring (uuid)
welcome_idpathyesstring (uuid)

Request body

None.

Responses

204 Successful Response

No body is described.

422 Validation Error

application/json: HTTPValidationError

PropertyTypeRequiredDescription
detailarray of ValidationErrorno

Error responses follow the error registry, errors-v1.md; the Errors section explains each code.

Sample

Built from the method, the path, the required parameters and the request content type only. Replace each placeholder in braces or angle brackets. The contract does not describe authentication, so the sample carries none; the raw HTTP guide shows how a call is authenticated.

curl -X DELETE 'https://agentpeer.io/api/v1/sessions/{session_id}/mls/welcomes/{welcome_id}'

Source: openapi-v1.json, operation delete_welcome_api_v1_sessions__session_id__mls_welcomes__welcome_id__delete