Skip to content

Send message(s) to actor

POST
/resources/actors/{type}/{externalId}

Processes incoming messages to a specific actor type and instance, either previewing or handling them,
depending on the request parameters.

For full actor documentation and details about the various types, see developer portal.

Parameters

Path Parameters

type*

The type of the actor to process the messages for.

Type
string
Required
externalId*

The external ID of the actor instance.

Type
string
Required

Request Body

Send an applyCommands message to add a tag to an order.

JSON
[
  
{
  
  
"type": "applyCommands",
  
  
"body": {
  
  
  
"commands": [
  
  
  
  
{
  
  
  
  
  
"type": "addTag",
  
  
  
  
  
"key": "vip"
  
  
  
  
}
  
  
  
]
  
  
}
  
}
]

Responses

OK

JSON
{
  
"paths": [
  
  
"string"
  
],
  
"data": {
  
  
"additionalProperties": "string"
  
},
  
"preview": true
}

Samples

© 2024 Hantera AB. All rights reserved.