Z-PRO icon

Z-PRO

Consome a API externa da Z-PRO (multiatendimento WhatsApp e outros canais)

Actions198

Oportunidades → Create Opportunity

AI-generated

Summary

Create a new opportunity in the Z-PRO system with optional detailed fields such as contact information, opportunity specifics, pipeline and stage identifiers, and assignment details.

Inputs

  • number — Contact's phone number, defaults to a Brazilian number; can be validated or sent as-is depending on 'Validate Number'.
  • contactName — Name of the contact associated with the opportunity.
  • email — Email address of the contact.
  • name — Name of the opportunity.
  • value — Monetary value assigned to the opportunity.
  • status — Current status of the opportunity (e.g., 'open').
  • pipelineId — Identifier for the sales pipeline to which this opportunity belongs.
  • stageId — Identifier for the stage within the pipeline for this opportunity.
  • responsibleId — Identifier of the user responsible for the opportunity.
  • closingForecast — Expected closing date for the opportunity in 'YYYY-MM-DD' format.
  • description — Additional notes or description text for the opportunity.
  • validateNumber — Boolean flag to indicate whether to normalize the phone number according to Brazilian 9-digit rules (default true). If false, the number is sent exactly as provided, useful to avoid duplicate tickets in WhatsApp Business API.

Output shape

a single record representing the created opportunity

The operation returns the created opportunity object as a single item. Optional fields not provided may be omitted or set to defaults. Number validation behavior depends on the 'validateNumber' input. Request options allow additional HTTP configurations like batching, proxy, and timeouts.

Examples

Example 1: Minimal opportunity creation

Provide at least the 'name' or 'contactName' to create an opportunity with minimal details. Other fields are optional.

Links

Discussion