Criar coluna de atendimento

curl --request POST \
  --url https://api.juridiq.com.br/consulting-columns/ \
  --header 'Content-Type: application/json' \
  --header 'x-juridiq-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "index": 1,
  "funnelId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "color": "<string>",
  "timeLimitDays": 1073741823,
  "showBadgeProgress": true
}
'

import requests

url = "https://api.juridiq.com.br/consulting-columns/"

payload = {
    "name": "<string>",
    "index": 1,
    "funnelId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "color": "<string>",
    "timeLimitDays": 1073741823,
    "showBadgeProgress": True
}
headers = {
    "x-juridiq-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-juridiq-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    index: 1,
    funnelId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    color: '<string>',
    timeLimitDays: 1073741823,
    showBadgeProgress: true
  })
};

fetch('https://api.juridiq.com.br/consulting-columns/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.juridiq.com.br/consulting-columns/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'index' => 1,
    'funnelId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'color' => '<string>',
    'timeLimitDays' => 1073741823,
    'showBadgeProgress' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-juridiq-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.juridiq.com.br/consulting-columns/"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"index\": 1,\n  \"funnelId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"color\": \"<string>\",\n  \"timeLimitDays\": 1073741823,\n  \"showBadgeProgress\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-juridiq-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.juridiq.com.br/consulting-columns/")
  .header("x-juridiq-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"index\": 1,\n  \"funnelId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"color\": \"<string>\",\n  \"timeLimitDays\": 1073741823,\n  \"showBadgeProgress\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.juridiq.com.br/consulting-columns/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-juridiq-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"index\": 1,\n  \"funnelId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"color\": \"<string>\",\n  \"timeLimitDays\": 1073741823,\n  \"showBadgeProgress\": true\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "index": 123,
  "timeLimitDays": 123,
  "showBadgeProgress": true,
  "kind": "PENDING",
  "officeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "funnelId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "color": "<string>"
}

{
  "message": "<string>",
  "statusCode": 123,
  "translateMessage": "<string>"
}

{
  "message": "<string>",
  "statusCode": 123,
  "translateMessage": "<string>"
}

{
  "message": "<string>",
  "statusCode": 123,
  "translateMessage": "<string>"
}

POST

consulting-columns

Criar coluna de atendimento

curl --request POST \
  --url https://api.juridiq.com.br/consulting-columns/ \
  --header 'Content-Type: application/json' \
  --header 'x-juridiq-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "index": 1,
  "funnelId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "color": "<string>",
  "timeLimitDays": 1073741823,
  "showBadgeProgress": true
}
'

import requests

url = "https://api.juridiq.com.br/consulting-columns/"

payload = {
    "name": "<string>",
    "index": 1,
    "funnelId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "color": "<string>",
    "timeLimitDays": 1073741823,
    "showBadgeProgress": True
}
headers = {
    "x-juridiq-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-juridiq-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    index: 1,
    funnelId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    color: '<string>',
    timeLimitDays: 1073741823,
    showBadgeProgress: true
  })
};

fetch('https://api.juridiq.com.br/consulting-columns/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.juridiq.com.br/consulting-columns/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'index' => 1,
    'funnelId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'color' => '<string>',
    'timeLimitDays' => 1073741823,
    'showBadgeProgress' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-juridiq-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.juridiq.com.br/consulting-columns/"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"index\": 1,\n  \"funnelId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"color\": \"<string>\",\n  \"timeLimitDays\": 1073741823,\n  \"showBadgeProgress\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-juridiq-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.juridiq.com.br/consulting-columns/")
  .header("x-juridiq-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"index\": 1,\n  \"funnelId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"color\": \"<string>\",\n  \"timeLimitDays\": 1073741823,\n  \"showBadgeProgress\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.juridiq.com.br/consulting-columns/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-juridiq-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"index\": 1,\n  \"funnelId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"color\": \"<string>\",\n  \"timeLimitDays\": 1073741823,\n  \"showBadgeProgress\": true\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "index": 123,
  "timeLimitDays": 123,
  "showBadgeProgress": true,
  "kind": "PENDING",
  "officeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "funnelId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "color": "<string>"
}

{
  "message": "<string>",
  "statusCode": 123,
  "translateMessage": "<string>"
}

{
  "message": "<string>",
  "statusCode": 123,
  "translateMessage": "<string>"
}

{
  "message": "<string>",
  "statusCode": 123,
  "translateMessage": "<string>"
}

Authorizations

x-juridiq-api-key

string

header

required

Chave de API do escritório (criada no painel). Envie o valor no header x-juridiq-api-key. A API aberta aplica rate limit por chave (veja a documentação de integradores).

Body

application/json

name

string

required

Nome da coluna

Minimum string length: 1

index

integer

Posição da coluna

Required range: x >= 0

funnelId

string<uuid>

ID do funil (usa o funil padrão do escritório se omitido)

color

string

Cor da coluna

timeLimitDays

integer

Prazo em dias

Required range: 0 <= x <= 2147483647

showBadgeProgress

boolean

Exibe badge de progresso

kind

enum<string>

Etapa da coluna; COMPLETED conclui o atendimento que entra nela

Available options:

PENDING,

IN_PROGRESS,

COMPLETED

Response

Default Response

string<uuid>

required

ID da coluna

name

string | null

required

Nome da coluna

index

number | null

required

Posição da coluna

timeLimitDays

number

required

Prazo em dias

showBadgeProgress

boolean

required

Exibe badge de progresso

kind

enum<string>

required

Etapa da coluna

Available options:

PENDING,

IN_PROGRESS,

COMPLETED

officeId

string<uuid>

required

ID do escritório

funnelId

string<uuid> | null

required

ID do funil

createdAt

required

Criado em

updatedAt

required

Atualizado em

color

string | null

Cor da coluna

Primeiros Passos

API Reference

Criar coluna de atendimento

Authorizations

Body

Response