Contacts

Vytvoření kontaktu

Vložení nového kontaktu do distribučního kanálu e-mailová kampaň nebo CATI

POST /distributions/{distribution_id}/contacts

Parametry:

Jméno parametru	Popis	Typ
distribution_id	Identifikátor distribučního kanálu, do kterého kontakt přidáváte	integer

Data kontaktu:

Jméno pole	Popis	Typ
import_number	Identifikace čísla importu pro rozlišení v seznamu kontaktů	integer, optional
email	E-mailová adresa - pro CATI položka není povinná	string, optional
phone	Telefonní číslo - pro e-mailovou kampaň položka není povinná	string, optional
first_name	Jméno - povinná, pokud se generuje oslovení: salutation_generate=true	string, optional
last_name	Příjmení - povinná, pokud se generuje oslovení: salutation_generate=true	string, optional
salutation	Oslovení - pokud je položka přítomna, nebude se oslovení generovat, ani když je salutation_generate=true	string, optional
company	Společnost	string, optional
department	Oddělení společnosti	string, optional
job	Pracovní zařazení	string, optional
mobile	Číslo mobilního telefonu	string, optional
user_field1	Uživatelské pole 1	string, optional
user_field2	Uživatelské pole 2	string, optional
user_field3	Uživatelské pole 3	string, optional
user_field4	Uživatelské pole 4	string, optional
user_field5	Uživatelské pole 5	string, optional
user_field6	Uživatelské pole 6	string, optional
user_field7	Uživatelské pole 7	string, optional
user_field8	Uživatelské pole 8	string, optional
user_field9	Uživatelské pole 9	string, optional
user_field10	Uživatelské pole 10	string, optional
salutation_generate	Generovat oslovení respondenta - vytvořit vokativ dle jména a příjmení (pouze pro CZ jména)	boolean, optional
salutation_prefix_male	Prefix oslovení pro muže - např: Vážený pane	string, optional
salutation_prefix_female	Prefix oslovení pro ženy - např: Vážená paní	string, optional
salutation_include_first_name	Zahrnout do oslovení jméno - např: Milý Františku	boolean, optional
salutation_include_last_name	Zahrnout do oslovení příjmení - např: Vážený pane Nováku	boolean, optional

Struktura vrácených dat:

Jméno pole	Popis	Typ
id	Identifikátor nově vytvořeného kontaktu	integer
survey_url	Unikátní URL adresa na dotazník pro nový kontakt	string
created_at	Datum a čas vytvoření nového kontaktu	date string

Příklad

curl --request POST \
  --url https://api.click4survey.com/v1/distributions/{distribution_id}/contacts \
  --header 'Accept: application/json' \
  --header 'X-API-TOKEN: {api-token}' \
  --header 'User-Agent: app-name ([e-mail])' \
  --header 'Content-Type: application/json' \
  --data '{"email":"[e-mail]","first_name":"John","last_name":"Doe","user_field1":"some data"}'

Přiklad dat požadavku

{
    "email": "[e-mail]",
    "first_name": "John",
    "last_name": "Doe",
    "user_field1": "some data"
}

Úspěšně zpracovaný požadavek vrací stavový kód 201 Created. V případě vrácení jiného kódu došlo při vytváření kontaktu k chybě. Zde je přehled chybových stavů.

Příklad vrácených dat požadavku

{
    "result": {
        "id": 554784, 
        "survey_url": "https://www.dev.click4survey.cz/m4/3177/00000000/00000000",
        "created_at": "2022-08-21T11:31:12Z"
    },
    "meta": {
        "requestId": "863c65c3-a895-4575-8f32-ae8b16648d26",
        "http_status": 201
    }
}