Kontakte / Personen

Attribute

Die Repräsentation der Person enthält neben den wichtigsten Eigenschaften ausserdem:
  • Tags (Tags)
  • Kunde oder Firma (Company)

{
    "id": 123,
    "firstname": "Peter",
    "lastname": "Muster",
    "title": "Dr. med.",
    "job_position": "Account Manager",
    "mobile_phone": "+41 123 45 67",
    "work_fax": "",
    "work_phone": "+41 445 45 67",
    "work_email": "peter.muster@beispiel.ch",
    "work_address": Beispiel AG\nPeter Muster\nBeispielstrasse 123",
    "home_email": "",
    "home_address": "",
    "birthday": "1959-05-22",
    "info": "",
    "avatar_url": "https//meinefirma.mocoapp.com/.../profil.jpg",
    "tags": [
        "Kunde",
        "Weihnachtskarte"
    ],
    "company": {
        "id": 123456,
        "type": "customer",
        "name": "Beispiel AG"
    }
}


GET contacts/people

Abruf aller Personen:

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

Die Antwort liefert ein Array mit vollständigen Personeninformationen (siehe Attribute) ausser info und tags .


GET contacts/people/{id}

Abruf einer einzelnen Person:

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

Die Antwort ist die Repräsentation einer einzelnen Person inkl. Tags und Firma/Kunde.


POST contacts/people

Erstellen einer Person:

curl -X POST \
  https://{domain}.mocoapp.com/api/v1/contacts/people \
  -H 'authorization: Token token={api-key}' \
  -H 'content-type: application/x-www-form-urlencoded' \
  -d 'firstname=Peter&lastname=Muster&bday=1959-05-22'

Pflichtfelder sind mit Stern (*) markiert:
  • firstname* – "Peter"
  • lastname* – "Muster"
  • customer_id oder organization_id – 123 (ID eines Kunden/einer Firma)
  • title – "Dr. med."
  • job_position – "Account Manager"
  • mobile_phone – "+49 177 123 45 67"
  • work_fax – "+49 30 123 45 67"
  • work_phone – "+49 30 123 45 67"
  • work_email – "bestellung@lieferant.de"
  • work_address – "Lieferant AG\nBeispielstrasse 123\n12345 Berlin"
  • home_email – "privat@home"
  • home_address – "Peter Muster\nZu Hause"
  • birthday – "1959-05-22"
  • info – "Eine Info zur Firma..."
  • tags – ["Weihnachtskarte", "Lieferant"]


PUT contacts/people/{id}

Aktualisieren einer Firma:

curl -X PUT \
  https://{domain}.mocoapp.com/api/v1/contacts/people/{123} \
  -H 'authorization: Token token={api-key}' \
  -H 'content-type: application/x-www-form-urlencoded' \
  -d 'job_position=Head of Sales'

Felder sind analog zur Erstellung.


DELETE contacts/people/{id}

Das Löschen einer Person ist über die API nicht möglich.


Mehr zu API...
30 Tage gratis

Account sofort startbereit. Voller Funktionsumfang. Ohne Zahlungsangaben.