Kontakty i grupy

Dodaj lub zaktualizuj kontakty

Upsert po numerze: istniejący kontakt z tym msisdn jest aktualizowany (podane pola nadpisują, pominięte zostają), nowy - tworzony. Treść żądania to jeden obiekt (odpowiedź 201 przy utworzeniu, 200 przy aktualizacji, zwraca kontakt) albo tablica do 500 obiektów (odpowiedź 201 { created, updated, invalid: [{ index, message }] }; błędne elementy nie przerywają importu). groups przyjmuje nazwy lub id gr_…; nieistniejące nazwy są tworzone; podanie groups zastępuje dotychczasowe przypisania kontaktu. Pola własne fields: klucz [a-zA-Z_][a-zA-Z0-9_]{0,30}, wartość do 200 znaków, maks. 20 pól - używasz ich w treści jako {{nazwa_pola}}. Wymaga zakresu manage.

post/v1/contacts

Request

  • Base URL: https://api.przypominamy.com
  • URL: https://api.przypominamy.com/v1/contacts
  • Auth: HTTP bearer

Request body

msisdnstring

Numer (E.164, bez plusa lub 9 cyfr = Polska); klucz upsertu

first_namestring nullable

Imię - placeholder {{imie}}

last_namestring nullable

Nazwisko - placeholder {{nazwisko}}

emailstring nullable

Placeholder {{email}}

fieldsobject nullable

Pola własne (do 20; klucz [a-zA-Z_][a-zA-Z0-9_]{0,30}) - placeholder {{nazwa_pola}}

groupsstring[]

Nazwy lub id grup; nieistniejące nazwy są tworzone; zastępuje dotychczasowe przypisania

Example request

{
  "msisdn": "+48600100200",
  "first_name": "Anna",
  "last_name": "Nowak",
  "fields": {
    "wizyta": "10.09 14:00"
  },
  "groups": [
    "VIP"
  ]
}

Response

Zaktualizowano istniejący kontakt (tylko dla pojedynczego obiektu)

idstring
msisdnstring
first_namestring nullable
last_namestring nullable
emailstring nullable
fieldsobject

Pola własne

created_atstring date-time
updated_atstring date-time

Example response

{
  "id": "ct_8fK2mQpL0aXz4Wv1",
  "msisdn": "+48600100200",
  "first_name": "Anna",
  "last_name": "Nowak",
  "fields": {
    "wizyta": "10.09 14:00"
  },
  "groups": [
    {
      "id": "gr_Zq7Lk2Pm9sT1",
      "name": "VIP"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.