Update async line items
This endpoint in the Tango API allows you to update an individual asynchronous order line item. Specify the line item’s reference ID and provide at least one field to update: delivery date, sender information, line item notes, or custom fields configured for the account.
Endpoint
Use the following endpoint to update an asynchronous order line item identified by its referenceLineItemId:
| Endpoint | Purpose |
|---|---|
PATCH {URI}/asyncOrders/lineItems/{referenceLineItemId} | To update async line item details under a specific Account. |
Use case
Acme Health submits an asynchronous order to reward employees for completing wellness activities. After submission, Acme identifies an incorrect employee ID on one line item. Using that item’s referenceLineItemId, Acme updates the employee ID in customFields without changing the other line items. The custom field must already be configured for the account in the Tango portal. See Create custom order fields in Tango Portal.
Parameters
Provide referenceLineItemId as a path parameter to identify the line item. In the request body, include at least one field to update: delivery date, sender information, line item notes, or custom fields.
| Path params | Data type | Requirement | Description |
|---|---|---|---|
| referenceLineItemId | string | required | length ≥ 1
Reference Line Item ID |
Include at least one of the following body parameters in the JSON request body to update the asynchronous line item:
| Body params | Data type | Requirement | Description |
|---|---|---|---|
| lineItemNote | string | optional | Specifies notes for the line item. Accepts 0–150 characters. |
| deliveryDate | string | optional | Specifies the date to deliver the reward to the recipient. The date must be at least 7 days in the future. If not specified, the reward will be immediately send. |
| senderInfor | object | optional | Specifies the sender’s name and email address to use instead of the platform defaults. |
| customFields | object | optional | Specifies custom field names and values to update for the line item. Only fields configured for the account in the Tango portal are accepted. |
Examples
Examples
This example shows the successful response structure for an asynchronous line item update. It includes the delivery date, line item notes in note, sender details in senderInfo, and custom field values in customFields:
{
"deliveryDate": "2026-10-30T20:45:13.550Z",
"note": "string",
"senderInfo": {
"firstName": "string",
"lastName": "string",
"email": "string"
},
"customFields": {}
}Response message
The possible response codes for this endpoint are as follows. For details, see i18nkey codes and their error messages:
| Response code | Meaning |
|---|---|
| 201 | A new resource has been successfully created in response to the request. |
| 400 | The server could not understand the request due to invalid syntax. |
| 401 | Authentication is required and has either not been provided or failed. |
| 404 | The server was unable to find the requested resource. In other words, the URL you're trying to access doesn't point to anything that exists on the server. |
| 429 | Exceeded the allowable TPS rate limit. It indicates that the user has sent too many requests in a given amount of time, and the server is rate-limiting further requests |
| 500 | Something went wrong on the server, but the server cannot be more specific about the exact problem. |
| 503 | The server is currently unable to handle the request due to temporary overload or maintenance. |
Updated about 12 hours ago
