Kontakte / Firmen

Attribute

Die Repräsentation der Firma enthält neben den wichtigsten Eigenschaften ausserdem:
  • Tags (Tags)
  • Kontaktpersonen (People)
{
    "id": 52331,
    "name": "Lieferant AG",
    "work_website": "http://www.lieferant.com",
    "work_fax": "+412345678",
    "work_phone": "+412345678",
    "work_email": "bestellung@lieferant.com",
    "work_address": "Lieferant AG\r\nBestellwesen\r\nBeispielweg 123\r\n8000 Zürich",
    "info": "",
    "tags": [
        "Weihnachtskarte",
        "Lieferant"
    ],
    "people": [
        {
            "id": 104,
            "firstname": "Peter",
            "lastname": "Muster"
        }
    ]
}


GET contacts/organizations

Abruf aller Firmen:

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

Die Antwort liefert ein Array mit vollständigen Firmeninformationen (siehe Attribute) ausser infotags und people.


GET contacts/organizations/{id}

Abruf einer einzelnen Firma:

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

Die Antwort ist die Repräsentation einer einzelnen Firme inkl. Tags und Kontaktpersonen.


POST contacts/organizations

Erstellen einer Firma:

curl -X POST \
  https://{domain}.mocoapp.com/api/v1/contacts/organizations \
  -H 'authorization: Token token={api-key}' \
  -H 'content-type: application/x-www-form-urlencoded' \
  -d 'name=Lieferant AG&tags[]=Weihnachtskarte&tags[]=Lieferant'

Pflichtfelder sind mit Stern (*) markiert:
  • name* – "Lieferant AG"
  • work_website – "http//www.lieferant.com"
  • 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"
  • info – "Eine Info zur Firma..."
  • tags – ["Weihnachtskarte", "Lieferant"]


PUT contacts/organizations/{id}

Aktualisieren einer Firma:

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

Felder sind analog zur Erstellung.


DELETE contacts/organizations/{id}

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


Mehr zu API...
30 Tage gratis

Account sofort startbereit. Voller Funktionsumfang. Ohne Zahlungsangaben.