Tagi

1. Pobranie listy istniejących tagów

Metoda pozwala na pobranie listy utworzonych w CRM tagów dla oznaczania zdarzeń.

Metoda: GET
Adres URL: {twoja_nazwa}.ccrm.pl/publicApi/tags

Struktura odpowiedzi

Właściwość

Wartość

Opis

success

bool


data.name

string

Opis wyświetlany na tagu.

data.uuid

uuid

Wartość identyfikująca rekord.

data.color


Kolor tła tagu.

type

array

Element CRM, dla którego dany tag może być używany (historia kontaktu, organizacje,osoby,pliki, BaseLinker- w przypadku włączonej integracji).

otherData.totalCount

int

Ilość rekordów.

message

string


Przykład odpowiedzi
{
    "success":true,
    "data":[
        {
            "name":"Nowy",
            "uuid":"739094bd-056b-403d-86f0-de805079797a",
            "color":"#cf5c60",
            "type":[
                "billing",
                "organisation",
                "person",
                "file"
            ]
        },
    ],
    "otherData":{
        "totalCount":16
    },
    "message":"OK"
}


2. Utworzenie tagu

Metoda pozwala na utworzenie nowego tagu.

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

Struktura żądania

Właściwość

Wartość

Opis

Wymagane

color

string

Kolor tła tagu.

TAK

name

string

Opis wyświetlany na tagu.

TAK

type

array

Element CRM, dla którego dany tag może być używany (historia kontaktu, organizacje,osoby,pliki, BaseLinker- w przypadku włączonej integracji).


type.*

string

person, organisation, billing, file, baselinker (opcjonalnie przy włączonej integracji).

TAK

Przykład żądania
{
    "color":"#000000",
    "name":"TAG123",
    "type":[
        "person",
        "organisation",
        "billing",
        "file"
    ]
}

Struktura odpowiedzi

Właściwość

Wartość

Opis

success

bool


data.name

string

Opis wyświetlany na tagu.

data.uuid

uuid

Wartość identyfikująca rekord.

data.color


Kolor tła tagu.

type

array

Element CRM, dla którego dany tag może być używany (historia kontaktu, organizacje,osoby,pliki, BaseLinker- w przypadku włączonej integracji).

otherData.totalCount

object

Ilość rekordów.

message

string


Przykład odpowiedzi
{
    "success":true,
    "data":{
        "name":"TAG123",
        "uuid":"d2bad9ae-af8b-45d8-8773-e84be3e21b33",
        "color":"#000000",
        "type":[
            "billing",
            "organisation",
            "person",
            "file"
        ]
    },
    "otherData":{
    },
    "message":"OK"
}


3. Edycja tagu

Metoda pozwala na edycję uprzednio utworzonego tagu.

Metoda: PATCH
Adres URL: {twoja_nazwa}.ccrm.pl/publicApi/tags/{uuid}

Struktura żądania

Właściwość

Wartość

Opis

Wymagane

color

string

Kolor tła tagu.

TAK

name

string

Opis wyświetlany na tagu.

TAK

type

array

Element CRM, dla którego dany tag może być używany (historia kontaktu, organizacje,osoby,pliki, BaseLinker- w przypadku włączonej integracji).


type.*

string

person, organisation, billing, file, baselinker (opcjonalnie przy włączonej integracji).

TAK

Przykład żądania
{
    "color":"#c4c4c4",
    "name":"TAG12"
}

Struktura odpowiedzi

Właściwość

Wartość

Opis

success

bool


data.name

string

Opis wyświetlany na tagu

data.uuid

uuid

Wartość identyfikująca rekord

data.color


Kolor tła tagu

type

array

Element CRM, dla którego dany tag może być używany (historia kontaktu, organizacje,osoby,pliki, BaseLinker- w przypadku włączonej integracji)

otherData.totalCount

object


message

string


Przykład odpowiedzi
{
    "success":true,
    "data":{
        "name":"SPAM12",
        "uuid":"e3675c7c-75c5-48de-8e7d-7065090d5d9a",
        "color":"#c4c4c4",
        "type":[
            "billing"
        ]
    },
    "otherData":{
    },
    "message":"OK"
}


4. Usunięcie tagu

Metoda pozwala na usunięcie uprzednio utworzonego tagu.

Metoda: DELETE
Adres URL: {twoja_nazwa}.ccrm.pl/publicApi/tags/{uuid}

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":{
        "totalCount":1
    },
    "message":"OK"
}



Revision #7
Created 13 January 2023 07:41:14 by tzukiewicz
Updated 30 August 2023 08:17:57 by Michał