Favorites
Bulk-update favorites
Apply per-row partial updates (typically `ranking` reorderings) to multiple favorites in a single request. Uses `Promise.allSettled` semantics: a 200 response can carry per-row failures in `data.faile
POST /v2/favorites/batch-update
Request body
Content-Type: application/json
updates
array<object> required
updates[].favoriteId
string (uuid) required
updates[].data
object required
updates[].data.ranking
integer
Example
{
"updates": [
{
"favoriteId": "00000000-0000-0000-0000-000000000000",
"data": {
"ranking": 0
}
}
]
}
Responses
200 — Successful response
Content-Type: application/json
data
object required
data.affected
integer required
data.ids
array<string>
data.failed
array<object>
data.failed[].id
string
data.failed[].error
object
data.failed[].error.code
string
data.failed[].error.message
string
Example
{
"data": {
"affected": 0
}
}
400
No response body.
401
No response body.
403
No response body.
404
No response body.
409
No response body.
429
No response body.
500
No response body.
Code samples
curl https://api.prod.getdex.com/v2/favorites/batch-update \
--request POST \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"updates": [
{
"favoriteId": "00000000-0000-0000-0000-000000000000",
"data": {
"ranking": 0
}
}
]
}'
fetch('https://api.prod.getdex.com/v2/favorites/batch-update', {
method: 'POST',
headers: {
Authorization: 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json'
},
body: JSON.stringify({
updates: [
{
favoriteId: '00000000-0000-0000-0000-000000000000',
data: {
ranking: 0
}
}
]
})
})
requests.post(
"https://api.prod.getdex.com/v2/favorites/batch-update",
headers={
"Authorization": "Bearer YOUR_API_KEY",
"Content-Type": "application/json"
},
json={
"updates": [
{
"favoriteId": "00000000-0000-0000-0000-000000000000",
"data": {
"ranking": 0
}
}
]
}
)
Bulk-create favorites
Create multiple favorites in a single request. Each entry must include exactly one of `group_id`, `view_id`, or `contact_id`. Returns `{ data: { favorites: [...] } }` with status 201. **Requires `Idem
Bulk-delete favorites
Permanently delete multiple favorites in a single request. Returns `{ data: { affected, ids } }`. `Idempotency-Key` is optional.