Leads

Attribute

Die Repräsentation des Leads enthält neben den wichtigsten Eigenschaften ausserdem:
  • Eigene Felder, falls vorhanden (Custom Properties)
  • Verantwortliche Person (User)
  • Kunde (Customer)
  • Akquise-Stufe (Category)
  • Status (potentialpendingwonlost oder dropped)
Der Kunde ist optional. Die Kategorie hat nur Auswirkungen im Status pending

{
    "id": 123,
    "name": "Website V2",
    "status": "pending",
    "reminder_date": "2017-05-19",
    "money": 61000,
    "currency": "CHF",
    "custom_properties": {
        "Typ": "Website"
    },
    "user": {
        "id": 933593033,
        "firstname": "Nicola",
        "lastname": "Piccinini"
    },
    "customer": {
        "id": 760260535,
        "name": "Beispiel AG"
    },
    "category": {
        "id": 12,
        "name": "Angebot",
        "probability": 30
    }
}


GET deals

Abruf aller Leads:

curl -X GET \
  https://{domain}.mocoapp.com/api/v1/deals \
  -H 'authorization: Token token={api-key}'

Die Antwort liefert ein Array mit vollständigen Leadinformationen (siehe Attribute).


GET deals/{id}

Abruf eines einzelnen Leads:

curl -X GET \
  https://{domain}.mocoapp.com/api/v1/deals/{123} \
  -H 'Authorization: Token token={api-key}'

Die Antwort ist die Repräsentation eines einzelnen Leads.


POST deals

Erstellen eines Leads:

curl -X POST \
  https://{domain}.mocoapp.com/api/v1/deals \
  -H 'authorization: Token token={api-key}' \
  -H 'content-type: application/x-www-form-urlencoded' \
  -d 'name=Beispiel AG Website Relaunch&currency=EUR&money=25000&reminder_date=2017-08-15&user_id=123&deal_category_id=456'

Pflichtfelder sind mit Stern (*) markiert:
  • name* – "Beispiel AG / Website Relaunch"
  • currency* – "EUR"
  • money* – 25000
  • reminder_date* – "2017-08-15"
  • user_id* – 123 (ID eines Benutzers)
  • deal_category_id* – 456 (ID einer Akquise-Stufe)
  • info – "Eine Info zum Lead..."
  • status – "potential", "pending", "won", "lost" oder "dropped" (Standard: "pending")


PUT deals/{id}

Aktualisieren eines Leads:

curl -X PUT \
  https://{domain}.mocoapp.com/api/v1/deals/{123} \
  -H 'authorization: Token token={api-key}' \
  -H 'content-type: application/x-www-form-urlencoded' \
  -d 'status=lost'

Felder sind analog zur Erstellung.


Mehr zu API...
30 Tage gratis

Account sofort startbereit. Voller Funktionsumfang. Ohne Zahlungsangaben.