Opportunité

Permet de consulter, créer et modifier des opportunités commerciales.

Récupérer les stades d'opportunité

GET /v1/opportunity/stade

Retourne la liste des stades d'opportunité disponibles.

Headers

Nom	Type	Requis	Description
x-access-token	String	oui	Clé API

Réponses

200 — OK

{
    "success": true,
    "code": "200",
    "message": "OK",
    "parameters": {},
    "result": {
        "stadeList": [
            {
                "id": "int",
                "label": "string",
                "order": "int",
                "created": "datetime",
                "modified": "datetime"
            }
        ]
    }
}

---

Récupérer les opportunités

GET /v1/opportunity

Retourne la liste des opportunités filtrées par société, stade ou période.

Headers

Nom	Type	Requis	Description
x-access-token	String	oui	Clé API

Paramètres query

Nom	Type	Requis	Description
idOpportunity	int	non	Identifiant de l'opportunité
idCompany	int	non	Identifiant de la société
siren	String	non	Numéro SIREN
idStade	int	non	Identifiant du stade (référence CustomFieldValue)
polling	int	non	Opportunités modifiées dans les X dernières minutes (min. 15)
pollingDeleted	int	non	Opportunités supprimées dans les X dernières minutes (min. 15)
isDeleted	boolean	non	Inclure les supprimées (défaut : false)

Réponses

200 — OK

{
    "success": true,
    "code": "200",
    "message": "OK",
    "parameters": {},
    "result": {
        "opportunityList": [
            {
                "idOpportunity": "int",
                "title": "string",
                "idCompany": "int",
                "idStade": "int",
                "deadline": "datetime|null",
                "amount": "float|null",
                "comment": "string|null",
                "idUserResponsable": "int",
                "idCrmVisitCard": "int|null",
                "isDeleted": "boolean",
                "created": "datetime",
                "modified": "datetime"
            }
        ]
    }
}

400 — Bad Request

{
    "success": false,
    "code": "400",
    "message": "Paramètre incorrect"
}

---

Créer ou modifier une opportunité

POST /v1/opportunity

Crée une nouvelle opportunité ou modifie une opportunité existante (si idOpportunity est fourni).

Headers

Nom	Type	Requis	Description
x-access-token	String	oui	Clé API

Body (JSON)

Nom	Type	Requis	Description
idOpportunity	int	non	Identifiant de l'opportunité (pour modification)
idCompany	int	oui	Identifiant de la société
title	String	non	Titre de l'opportunité
idUserResponsable	int	conditionnel	Identifiant du responsable. Alternatif à userResponsableEmail
userResponsableEmail	String	conditionnel	Email du responsable. Alternatif à idUserResponsable
idStade	int	non	Identifiant du stade
deadline	datetime	non	Date d'échéance
amount	float	non	Montant
comment	String	non	Commentaire
idCrmVisitCard	int	conditionnel	Identifiant du contact CRM. Alternatif à crmVisitCardEmail
crmVisitCardEmail	String	conditionnel	Email du contact CRM. Alternatif à idCrmVisitCard

Réponses

200 — OK

{
    "success": true,
    "code": "200",
    "message": "OK",
    "parameters": {},
    "result": {
        "idOpportunity": "int"
    }
}

400 — Bad Request

{
    "success": false,
    "code": "400",
    "message": "Le paramètre idCompany est requis"
}

404 — Not Found

{
    "success": false,
    "code": "404",
    "message": "Opportunité introuvable"
}