Add Favorite

POST

/org/{tenant}/v2/contacts/favorites

Platform support: MT and CC

Add a contact to the user's favorites. The favorite type determines how contact_id is interpreted:

• bcm — contact_id must be a positive integer string (BCM contact ID)
• ext — contact_id is a PBX extension UUID
• other — contact_id is a mobile/external contact identifier; optionally include contact_data with metadata

A per-user limit (default 50) is enforced server-side.

Request

Responses

201

Favorite created.

400

Bad request — the request was invalid (validation error, malformed body, or missing/invalid parameters).

401

Unauthorized — missing or invalid identity, or insufficient permissions.

404

Not Found — the requested resource does not exist.

409

Conflict — the request conflicts with the current state (e.g. sync already active).

500

Internal Server Error — an unexpected error occurred.