Model Sync Error Handling

Update Sync Error Handling

Updates the error handling settings for a model sync.

put/api/syncs/{id}/error-handling

Path parameters

idstring uuid required

Unique identifier of the model sync.

Example:248df4b7-aa70-47b8-a036-33ac447e668d

Unique identifier of the model sync.

Headers

X-Polytomic-Versionstring

Request body

auto_retry_record_errorsboolean nullable

Whether records that fail are automatically retried on the next run. Omit to leave unchanged.

notify_on_record_errorsboolean nullable

Whether subscribers are notified when individual records fail, in addition to whole-sync failures. Omit to leave unchanged.

subscribersstring[] nullable

Email addresses notified when this sync fails. Replaces the current list; pass an empty list to unsubscribe everyone. Omit to leave the list unchanged.

warning_notificationsboolean nullable

Whether subscribers are notified when the sync completes with warnings. Omit to leave unchanged.

Example request

{
  "auto_retry_record_errors": true,
  "notify_on_record_errors": true,
  "subscribers": [
    "alerts@example.com"
  ],
  "warning_notifications": true
}

Response

Example response

{
  "data": {
    "auto_retry_record_errors": true,
    "notify_on_record_errors": true,
    "subscribers": [
      "alerts@example.com"
    ],
    "warning_notifications": true
  }
}