VICIdial icon

VICIdial

Interact with VICIdial Non-Agent API

Lead Management → Lead Dearchive

AI-generated

Summary

Dearchives a lead in VICIdial, restoring it to an active state.

Inputs

  • baseURL (required) — Base VICIdial URL (no trailing /vicidial portion).
  • function (required) — API function name, must be 'lead_dearchive'.
  • user — Credentials username, defaults to VICIdial credential.
  • pass — Credentials password, defaults to VICIdial credential.
  • source — Source, defaults from the VICIdial credential.
  • lead_id (required) — The unique ID of the lead to dearchive.
  • requestOptions — Additional request options, including batching and timeout.

Output shape

no body — success/failure only

The operation does not return any data upon success, only indicates success or failure.

Examples

Example 1: Restore a previously archived lead in VICIdial.

Provide base URL, lead ID, and ensure proper authentication credentials.

Discussion