Skip to content

Delete a tip dismissal

Platform module

DELETE/tip-dismissals/{id}tipDismissals.delete

A contextual tip the caller dismissed (0642). Deleting it shows the tip again; a reset dismissal is never revived. Soft-deletes the tip dismissal: it moves to Trash and can be restored for its table's retention period.

  • Requires the capability me.preferences.write.
  • OAuth scopes: me.
  • Error statuses: 401, 404, 422, 429. Errors are RFC 9457 problem details.

Path and query parameters

tipDismissals.delete: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the tip dismissal.

Response 204: no body.

Code samples

curl -X DELETE "$XOS_BASE_URL/tip-dismissals/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data } = await xos.tipDismissals.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.tip_dismissals.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos tip-dismissals delete 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f