Archive a Participant

post/public/v1/participants/{participant}/archive

post/public/v1/participants/{participant}/archive

curl --request POST \
  --url 'https://api.app.astalty.com.au/public/v1/participants/{participant}/archive' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "exit_date": "string",
  "exit_details": "string",
  "exit_reason": "string"
}'

Response

[]

Authorization

Authorizationstringrequired
Bearer authentication header of the form Bearer <token>, where <token> is your API key. See How to set up an API key.

Path parameters

participantstringrequired
The participant UUID

Body

application/json

exit_datestring | null
exit_detailsstring | nullmax length 65535
Limited to 65535 bytes.
exit_reasonstring | nullmax length 255

Response

200application/json

Errors

401Unauthenticated
403Authorization error
404Not found
422Validation error