push_notifications

PATCH /push_notifications/{id}/

Changed on

Request

  • The document declares no server URL.
  • Auth
    API key in header Authorization

Path parameters

idstring uuid required

A UUID string identifying this push notification.

Query parameters

format'json' | 'xlsx'

Request body

idstring uuid
urlstring uri
accountstring uri
external_idstring uuid nullable
state'queued' | 'pending' | 'failed' | 'sent'
notificationstring uri
recipientstring uri
taskstring uri
subjectstring
messagestring
errorstring nullable
pending_atstring date-time
failed_atstring date-time
sent_atstring date-time
created_atstring date-time

Response

idstring uuid required
urlstring uri required
accountstring uri required
external_idstring uuid nullable
state'queued' | 'pending' | 'failed' | 'sent' required
notificationstring uri required
recipientstring uri required
taskstring uri required
subjectstring
messagestring required
errorstring nullable
pending_atstring date-time required
failed_atstring date-time required
sent_atstring date-time required
created_atstring date-time required

Changes

    • info

      media type application/json; version=2.4.12 was changed to application/json; version=2.4.13 for the response status

    • info

      media type application/xlsx; version=2.4.12 was changed to application/xlsx; version=2.4.13 for the response status

    • info

      media type application/json; version=2.4.11 was changed to application/json; version=2.4.12 for the response status

    • info

      media type application/xlsx; version=2.4.11 was changed to application/xlsx; version=2.4.12 for the response status