Update a specific sync status

Update a specific sync status.

patch/sync-statuses/{sync_status_id}

Request

Base URL
https://enterprise.knak.io/api/published/v1
Auth
none declared
TypeScript
https://skmtc.dev/knak/apis/knak-enterprise-api/docs/sync-statuses/:sync_status_id/patch.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

sync_status_idstring required

ID of the sync status to update

Request body

map_idstring

map_urlstring nullable

error_messagestring nullable

status'in_progress' | 'complete' | 'error' | 'confirmation_requested'

Example request

{
  "map_url": "https://www.map.com/123456",
  "error_message": "Error creating asset in MAP"
}

Response

Example response

{
  "data": {
    "type": "sync-status",
    "id": "609d7ce223411",
    "attributes": {
      "id": "609d7ce223411",
      "type": "sync",
      "status": "in_progress",
      "error_message": "Error creating asset in MAP",
      "map_url": "https://www.map.com/123456",
      "last_user_confirmation_response": "continue"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.