Saltar al contenido

Create a tip dismissal

Módulo Platform

POST/tip-dismissalstipDismissals.create

A contextual tip the caller dismissed (0642). Deleting it shows the tip again; a reset dismissal is never revived. Creates a tip dismissal. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

  • Requiere la capacidad me.preferences.write.
  • Alcances de OAuth: me.
  • Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
  • Estados de error: 400, 401, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Cuerpo de la solicitud: TipDismissalCreate

tipDismissals.create: TipDismissalCreate
CampoTipoObligatorioDescripción
tip_keystringSíTip key from the help content.Restricciones: pattern ^[a-z][a-z0-9-]*(\.[a-z][a-z0-9-]*)*$; length 0 to 100
{
  "tip_key": "gates"
}

Respuesta 201: TipDismissal

tipDismissals.create: TipDismissal
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the tip dismissal.
org_idstring (uuid)SíIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)SíWhen the row was created.
created_bystring (uuid) | nullSíIdentifier of the person who created the row.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíIdentifier of the person who last updated the row.
membership_idstring (uuid)SíIdentifier of the membership of the caller, set by the server.
tip_keystringSíTip key from the help content.Restricciones: pattern ^[a-z][a-z0-9-]*(\.[a-z][a-z0-9-]*)*$; length 0 to 100
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "tip_key": "gates"
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/tip-dismissals" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"tip_key":"gates"}'
const { data } = await xos.tipDismissals.create({
    "tip_key": "gates"
  });
response = xos.tip_dismissals.create({"tip_key": "gates"})
xos tip-dismissals create --data '{"tip_key":"gates"}'