Transfer contact
Reassigns a contact to another agent (user). The contact's owner becomes the receiving agent, a transfer interaction is recorded in the contact's history, and the receiving agent is notified. Any pending reminder is cancelled and any archiving reason is cleared, so the contact becomes active again. If the contact is already assigned to the receiving agent, no transfer is made: a note is added instead and the request still succeeds.
bearerAuthAuthorizationBearer <token>API key sent as Authorization: Bearer <API_KEY>.
idcontact*stringID of the contact to transfer.
The agent receiving the contact and an optional note explaining the transfer.
application/json- body
to*stringUser ID of the agent receiving the transfer. Must belong to your company or one of its groups. The user's email, phone or company ID are also accepted.
description?stringOptional note explaining the reason for the transfer. Saved on the transfer interaction in the contact's history. Max 2056 characters.
length <= 2056OK
application/json; charset=utf-8- response
success?booleanmessage?stringcurl -X POST 'https://api.getventia.com/api/v1.0/contact/string/transfer' \ -H 'Content-Type: application/json' \ -d '{ "to": "6234da84259c59d9a555c498"}'{ "message": "The contact was successfully transfered...", "success": true}