Notizen

Attribute

Die Repräsentation der Notiz enthält ausserdem eine Kurzversion des Erstellers (User).

{
    "id": 123,
    "commentable_id": 12345,
    "commentable_type": "Project",
    "text": "Projekt wurde beauftragt am 1.10.2017.",
    "manual": true,
    "created_at": "2017-11-27 09:33:46 +0100",
    "updated_at": "2017-11-27 09:33:46 +0100",
    "user": {
        "id": 567,
        "firstname": "Tobias",
        "lastname": "Miesel"
    }
}

GET comments

Abruf aller Notizen:

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

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

Zusätzlich sind folgende Parameter möglich:
  • commentable_type – "User", "Deal", "Offer", "OfferConfirmation", "Customer", "Project", "Invoice", "Contact" (Objekt der Notiz)
  • commentable_id – 123 (ID des Objekts)
  • user_id – 456 (ID des Erstellers)
  • manual – true/false (manuell erstellte oder automatische Notizen)

GET comments/{id}

Abruf einer einzelnen Notiz:

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

Die Antwort ist die Repräsentation einer einzelnen Notiz.

POST comments

Erstellen einer Notiz:

curl -X POST \
  https://{domain}.mocoapp.com/api/v1/comments \
  -H 'authorization: Token token={api-key}' \
  -H 'content-type: application/x-www-form-urlencoded' \
  -d 'commentable_id=123&commentable_type=Project&text=Projekt ist beauftragt!'

Pflichtfelder sind mit Stern (*) markiert:
  • commentable_id* – 123 (ID des Objekts)
  • commentable_type* – "User", "Deal", "Offer", "OfferConfirmation", "Customer", "Project", "Invoice", "Contact" (Objekt der Notiz)
  • text* – "Der Text der Notiz..."

PUT comments/{id}

Aktualisieren einer Notiz:

curl -X PUT \
  https://{domain}.mocoapp.com/api/v1/comments/{123} \
  -H 'authorization: Token token={api-key}' \
  -H 'content-type: application/x-www-form-urlencoded' \
  -d 'text=Beauftragung wurde zurückgezogen.'

Felder sind analog zur Erstellung.

DELETE comments/[id]

Das Löschen von manuell erfassten Notizen:

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

Mehr zu API...
30 Tage gratis

Account sofort startbereit. Voller Funktionsumfang. Ohne Zahlungsangaben.