Plazbot

Create Opportunity

POST

/api/opportunity

opportunity

Servicio de creación de una oportunidad.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.plazbot.com/api/opportunity' \
--header 'x-workspace-id;' \
--header 'Content-Type: application/json' \
--data-raw '{
  "workspaceId": "string",
  "name": "string",
  "description": "string",
  "contactId": "string",
  "userCreation": "string",
  "amount": 1200.50
}'

Response Example

{
  "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
    }
  }
}

Request

Header Params

x-workspace-id

string

required

Body Params application/json

workspaceId

string

required

WorkspaceID

name

string

required

Nombre de la oportunidad.

description

string

required

Descripcion de la oportunidad

contactId

string

optional

Contact Id asociado a la oportunidad.

amount

number

required

Monto de la oportunidad

Examples

Responses

🟢200OK

application/json

Body

success

boolean

required

code

integer

required

errorCode

null

required

message

string

required

data

object

required

string

required

opportunity

object

required

Modified at 2025-04-21 20:05:08

Get Opportunity

Get Opportunity by Id