Skip to main content
POST
/
api
/
opportunity
Create Opportunity
curl --request POST \
  --url https://api.plazbot.com/api/opportunity \
  --header 'Content-Type: application/json' \
  --header 'x-workspace-id: <x-workspace-id>' \
  --data '{
  "workspaceId": "string",
  "name": "string",
  "description": "string",
  "assignedComercialId": "string",
  "amount": 1200.5
}'
{
  "success": true,
  "code": 200,
  "errorCode": null,
  "message": "Opportunity successfully created.",
  "data": {
    "id": "string",
    "opportunity": {
      "id": "string",
      "opportCode": "string",
      "opportStatus": 1,
      "winLossStatus": 0,
      "winLossDate": null,
      "finalAmount": 0,
      "creationDate": "2025-04-08T03:52:53.3774876Z",
      "creationTypeId": 1,
      "updatedDate": null,
      "deletionDate": null,
      "userDeletion": null,
      "statusId": 1,
      "files": [],
      "orderInCards": 1,
      "orderInCardsLastUpdated": "2025-04-08T03:52:54.663308Z",
      "activities": [],
      "segmentationId": null,
      "workspaceId": "string",
      "name": "string",
      "description": "string",
      "amount": 0,
      "userCreation": "string",
      "contactId": "string",
      "expirationDate": null,
      "assignedAgentId": null,
      "stageId": null
    }
  }
}

Headers

x-workspace-id
string
required

Body

application/json
workspaceId
string
required

WorkspaceID

name
string
required

Nombre de la oportunidad.

description
string
required

Descripcion de la oportunidad

amount
number
required

Monto de la oportunidad

assignedComercialId
string

Comercial Id asociado a la oportunidad. Esta informacion se puede sacar de la api de User: GetInformationByEmail

contactId
string

Contacto Id asociado a la oportunidad. Esta informacion se puede sacar de la api de Create Contact

Response

200 - application/json

OK

success
boolean
required
code
integer
required
errorCode
null
required
message
string
required
data
object
required
I