Skip to main content

Własne pola

1. Pobranie listy istniejących własnych pól

Metoda pozwala na pobranie listy utworzonych własnych pól dla kontaktów, odpowiednio dla osób oraz organizacji.

Metoda: GET
Adres URL (dla kontaktów- osób): www.{twoja_nazwa}.ccrm.pl/publicApi/people/customFields

Metoda: GET
Adres URL (dla kontaktów- organizacji): www.{twoja_nazwa}.ccrm.pl/publicApi/organisations/customFields

Struktura odpowiedzi

Właściwość

Wartość

Opis

success

bool


data.uuid

string

Wartość identyfikująca rekord.

data.type

string

Typ własnego pola.

data.param

object

Parametry własnego pola, zależne od typu, patrz tabela pierwsza.

data.param.contactType

array

Lista typów kontaktów do których przypisane jest własne pole, możliwe:
person, organisation.

data.canDelete

bool

Flaga oznaczająca możliwość usunięcia własnego pola.

otherData

object


message

string


Przykład odpowiedzi 
{
    "success":true,
    "data":[
        {
            "uuid":"7b0abc08-afa4-4946-ad23-ad4646072853",
            "type":"date",
            "param":{
                "type":"date",
                "name":"Data zamówienia",
                "required":true,
                "contactType":[
                    "person",
                    "organisation"
                ]
            },
            "canDelete":1
        },
        {
            "uuid":"12350856-bfba-4a7e-b69c-da35b8a6a3e1",
            "type":"text",
            "param":{
                "type":"text",
                "name":"Tekst wielolin",
                "required":false,
                "contactType":[
                    "person",
                    "organisation"
                ],
                "isLink":false,
                "isMultiline":true,
                "minLength":0,
                "maxLength":15,
                "uuid":"12350856-bfba-4a7e-b69c-da35b8a6a3e1"
            },
            "canDelete":1
        },
        {
            "uuid":"96d8ad7a-ffef-4b5f-a38f-f21e7c8bb97e",
            "type":"number",
            "param":{
                "type":"number",
                "name":"number",
                "required":false,
                "contactType":[
                    "person",
                    "organisation"
                ],
                "minValue":5,
                "maxValue":20,
                "uuid":"96d8ad7a-ffef-4b5f-a38f-f21e7c8bb97e"
            },
            "canDelete":1
        },
        {},
        {
            "uuid":"183619e0-af10-4584-b260-bd81324a6ec2",
            "type":"select",
            "param":{
                "type":"select",
                "name":"Lista rozw",
                "required":true,
                "contactType":[
                    "organisation",
                    "person"
                ],
                "isMultiple":true,
                "options":[
                    "cd",
                    "dvd"
                ]
            },
            "canDelete":1
        },
        {
            "uuid":"c894f58b-fe44-4afa-9776-bf44bf820bf4",
            "type":"checkbox",
            "param":{
                "type":"checkbox",
                "name":"checkboxTest",
                "required":false,
                "contactType":[
                    "person",
                    "organisation"
                ]
            },
            "canDelete":1
        }
    ],
    "otherData":{
    },
    "message":"OK"
}

2. Dodanie pola własnego

Metoda pozwala na utworzenie nowego własnego pola dla kontaktu.

Metoda: POST
Adres URL:  www.{twoja_nazwa}.ccrm.pl/publicApi/customFields

2.1 Pole tekstowe

Struktura żądania

Właściwość

Wartość

Możliwe wartości

Opis

Wymagane

contactType

array

person

organisation

Określa, czy pole ma zostać dopisane do profili osób czy organizacji.

TAK

required

bool

true

false

Określa, czy pole jest wymagane do uzupełnienia podczas edycji profilu.

TAK

name

string


Określa nazwę pola.

TAK

type

string

text

Wskazuje typ pola.

TAK

minLenght

int

number

Określa minimalną ilość znaków jaką przyjmuje pole

TAK

maxLenght

int

number

Określa maksymalną ilość znaków jaką przyjmuje pole

TAK

isMultiline

bool

true

false

Określa, czy pole jest polem wieloliniowym

TAK

isLink

bool

true

false

Określa, czy wartość wpisana w polu jest linkiem

TAK
Przykład żądania 
{
    "type":"text",
    "name":"Pole tekstowe",
    "required":false,
    "contactType":[
        "person",
        "organisation"
    ],
    "isLink":true,
    "isMultiline":true,
    "minLength":0,
    "maxLength":50

}

Struktura odpowiedzi

Właściwość

Wartość

success

bool

data

string

otherData

object

message

string
Przykład odpowiedzi 
{
    "success":true,
    "data":"OK",
    "otherData":{
    },
    "message":"OK"
}


2.2 Pole numeryczne

Struktura żądania

Właściwość

Wartość

Możliwe wartości

Opis

Wymagane

contactType

array

person

organisation

Określa, czy pole ma zostać dopisane do profili osób czy organizacji.

TAK

required

bool

true

false

Określa, czy pole jest wymagane do uzupełnienia podczas edycji profilu.

TAK

name

string


Określa nazwę pola.

TAK

type

string

number

Wskazuje typ pola.

TAK

minValue

int

number

Określa minimalną wartość pola.

TAK

maxValue

int

number

Określa maksymalną wartość pola.

TAK
Przykład żądania 
{
    "type":"number",
    "name":"Pole numeryczne",
    "required":false,
    "contactType":[
        "person",
        "organisation"
    ],
    "minValue":0,
    "maxValue":100
}

Struktura odpowiedzi

Właściwość

Wartość

success

bool

data

string

otherData

object

message

string
Przykład odpowiedzi 
{
    "success":true,
    "data":"OK",
    "otherData":{
    },
    "message":"OK"
}


2.3 Lista rozwijana

Struktura żądania

Właściwość

Wartość

Możliwe wartości

Opis

Wymagane

contactType

array

person

organisation

Określa, czy pole ma zostać dopisane do profili osób czy organizacji.

TAK

required

bool

true

false

Określa, czy pole jest wymagane do uzupełnienia podczas edycji profilu.

TAK

name

string


Określa nazwę pola.

TAK

type

string

select

Wskazuje typ pola.

TAK

options

array


Możliwe wartości (poszczególne wybory w liście.

TAK

isMultiple

bool

number

Określa czy pole pozwala na wielokrotny wybór

TAK
Przykład żądania 
{
    "type":"select",
    "name":"Lista rozwijana",
    "required":true,
    "contactType":[
        "person",
        "organisation"
    ],
    "isMultiple":true,
    "options":[
        "Opcja 1",
        "Opcja 2"
    ]
}

Struktura odpowiedzi

Właściwość

Wartość

success

bool

data

string

otherData

object

message

string
Przykład odpowiedzi 
{
    "success":true,
    "data":"OK",
    "otherData":{
    },
    "message":"OK"
}

2.4 Checkbox

Struktura żądania

Właściwość

Wartość

Możliwe wartości

Opis

Wymagane

contactType

array

person

organisation

Określa, czy pole ma zostać dopisane do profili osób czy organizacji.

TAK

required

bool

true

false

Określa, czy pole jest wymagane do uzupełnienia podczas edycji profilu.

TAK

name

string


Określa nazwę pola.

TAK

type

string

checkbox

Wskazuje typ pola.

TAK
Przykład żądania 
{
    "type":"checkbox",
    "name":"Checkbox",
    "required":true,
    "contactType":[
        "person",
        "organisation"
    ]
}

Struktura odpowiedzi

Właściwość

Wartość

success

bool

data

string

otherData

object

message

string
Przykład odpowiedzi 
{
    "success":true,
    "data":"OK",
    "otherData":{
    },
    "message":"OK"
}

2.5 Data

Struktura żądania

Właściwość

Wartość

Możliwe wartości

Opis

Wymagane

contactType

array

person

organisation

Określa, czy pole ma zostać dopisane do profili osób czy organizacji.

TAK

required

bool

true

false

Określa, czy pole jest wymagane do uzupełnienia podczas edycji profilu.

TAK

name

string


Określa nazwę pola.

TAK

type

string

date

Wskazuje typ pola.

TAK
Przykład żądania 
{
    "type":"date",
    "name":"Data",
    "required":true,
    "contactType":[
        "person",
        "organisation"
    ]
}

Struktura odpowiedzi

Właściwość

Wartość

success

bool

data

string

otherData

object

message

string
Przykład odpowiedzi 
{
    "success":true,
    "data":"OK",
    "otherData":{
    },
    "message":"OK"
}

2.6 Data i czas

Właściwość

Wartość

Możliwe wartości

Opis

Wymagane

contactType

array

person

organisation

Określa, czy pole ma zostać dopisane do profili osób czy organizacji.

TAK

required

bool

true

false

Określa, czy pole jest wymagane do uzupełnienia podczas edycji profilu.

TAK

name

string


Określa nazwę pola.

TAK

type

string

datetime

Wskazuje typ pola.

TAK
Przykład żądania 
{
    "type":"datetime",
    "name":"Data i czas",
    "required":true,
    "contactType":[
        "person",
        "organisation"
    ]
}

Struktura odpowiedzi

Właściwość

Wartość

success

bool

data

string

otherData

object

message

string
Przykład odpowiedzi 
{
    "success":true,
    "data":"OK",
    "otherData":{
    },
    "message":"OK"
}


3. Edycja istniejącego pola własnego

Metoda pozwala na edycję utworzonego wcześniej własnego pola dla kontaktu. 

Metoda: PATCH
Adres URL: www.{twoja_nazwa}.ccrm.pl/publicApi/customFields

Struktury żądań dla edycji wybranego rodzaju pola są identyczne jak w przypadku punktu 2 "Dodanie nowego pola własnego".


4. Usunięcie istniejącego pola własnego

Metoda pozwala na usunięcie utworzonego wcześniej własnego pola dla kontaktu.

Metoda: DELETE
Adres URL: www.{twoja_nazwa}.ccrm.pl/publicApi/customFields

Struktura odpowiedzi

Właściwość

Wartość

Opis

success

bool


data

string


otherData.totalCount

int

Ilość usuniętych rekordów.

message

string


Przykład odpowiedzi 
{
    "success":true,
    "data":"OK",
    "otherData":{
    },
    "message":"OK"
}
Back to top