Update an item
Updates the fields of a list item that are passed in the request. Missing fields will keep their values. Returns all items of the updated list attribute.
Please log in to see full path URL. Learn why.
patch
/people/3/lists/{listName}/items/{itemId}
Authorizations:
Scopes:
Request rate limit:
3 requests / second (per account)
path Parameters
listName required | string Name of the list attribute. |
itemId required | string UUID of the list item to update. |
query Parameters
type required | string Enum: "ID" "EXTERNAL_ID" "PHONE" "EMAIL" "LINE" "FACEBOOK" "TELEGRAM" "PUSH" "LIVE_CHAT" "VIBER_BOTS" "INSTAGRAM" "INSTAGRAM_DM" "TWITTER" "APPLE_BUSINESS_CHAT" "KAKAO_SANGDAM" "OPEN_CHANNEL" Type of the person ID. Can be one of the above. |
identifier required | string Person ID. ID type must match the |
sender | string Sender or application ID. |
Request Body schema:
application/jsoncollapse all -
Responses
200
Success
400
Bad request
401
Unauthorized
403
Forbidden
404
Not found
429
Too Many Requests
500
Internal Server Error
Request samples
- Payload
- cURL
- Java
- C#
- Go
- Python
- PHP
- JavaScript
- NodeJs
- Ruby
Content type
application/json
Copy
Collapse all {- "item_field_#1": "new field value"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 429
- 500
Content type
application/json
Copy
Collapse all [- {
- "__id": "78f47a5a-b9c4-4802-8bed-e81cf5fde0b4",
- "item_field_#1": "new field value"
}, - {
- "__id": "b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f",
- "item_field_#1": "some value",
- "item_field_#2": 42
}
]
Need assistance
Encountering issues
What's new? Check out
Unsure about a term? See