PApaperlessparts
Integration Actions

Update fields on an integration action

Update fields on an integration action.

patch/integration_actions/public/{integration_action_uuid}

Request

Path parameters

integration_action_uuidstring required

The unique identifier for the integration action to be returned

Request body

statusstring

the new status of the integration action

status_messagestring

The new status message for the integration

Example request

{
  "status": "in_progress",
  "status_message": "The order 8 is now processing"
}

Response

Successful response

uuidstring uuid
typestring

the type of action being requested

createdstring date-time
updatedstring date-time
current_record_countinteger
last_checkinstring date-time nullable
related_objectstring nullable
related_object_typestring
statusstring

The current status of the action

status_messagestring
entity_idstring

The identifier for the entity that should be processed as part of the action. For example, process order 8

Example response

{
  "type": "export_order",
  "status": "in_progress",
  "status_message": "Order 8 is currently being processed",
  "entity_id": "8"
}

Changes

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