Kontakty

Adresář kontaktů workspace můžete přes API vypisovat, importovat, upravovat i mazat.

Výpis kontaktů

curl -H "x-api-key: VAS_API_KLIC" https://api.signi.com/api/v1/contacts/list

[
    {
        "contact_id": 123456,
        "fullname": "Jan Novák",
        "email": "jan.novak@email.cz",
        "firstname": "Jan",
        "lastname": "Novák"
    }
]

Import kontaktů

Kontakty se importují jako soubor CSV — povinné sloupce lastname a email, další (např. firstname, phone) jsou volitelné:

curl -X POST -H "x-api-key: VAS_API_KLIC" \
  https://api.signi.com/api/v1/contacts/import \
  -F "file=@kontakty.csv"

Co se vrátí:

{ "created": 1, "updated": 0, "skipped": 0, "skippedDupliciteEmail": 0 }

Pro velké dávky použijte asynchronní variantu — stejné volání na POST /api/v1/contacts/import/async. Vrátí se hned:

{ "batchId": 123 }

Průběh dávky pak zjistíte přes GET /api/v1/contacts/import/123:

{ "id": 123, "type": "import", "status": "finished",
  "results": { "created": 1, "updated": 0, "skipped": 0, "createdContactIds": [123456] } }

Úprava kontaktu

curl -X PATCH -H "x-api-key: VAS_API_KLIC" -H "Content-Type: application/json" \
  https://api.signi.com/api/v1/contacts/ID_KONTAKTU \
  -d '{ "firstname": "Petr" }'

Pošlete jen pole, která chcete změnit.

Smazání kontaktu

curl -X DELETE -H "x-api-key: VAS_API_KLIC" \
  https://api.signi.com/api/v1/contacts/ID_KONTAKTU

Kam dál

• Více podepisujících — údaje o lidech při zakládání dokumentu
• Štítky
• Referenční dokumentace