{"info":{"_postman_id":"c0b601ae-c2c1-4153-a6b0-49f6b5144e2f","name":"Rvops -  Documentação de API","description":"<html><head></head><body><p>A <strong>API da Rvops</strong> é uma ferramenta que oferece aos desenvolvedores a capacidade de acessar dados de objetos e outras informações essenciais dentro da plataforma. Com ela, é possível criar soluções exclusivas que atendam às necessidades específicas de negócios, indo além das funcionalidades e recursos fornecidos pela Rvops. Além disso, é possível integrar os Serviços Rvops com outras plataformas. Essa abordagem resulta em uma maior satisfação e fidelidade do cliente, pois as empresas podem adaptar suas estratégias de engajamento para atender às demandas de seu público-alvo.</p>\n<hr>\n<h2 id=\"autenticação\">Autenticação</h2>\n<p>Todas as requisições à API da Rvops exigem autenticação via <strong>API Key</strong>. A chave deve ser enviada no header da requisição.</p>\n<p><strong>Header:</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Header</th>\n<th>Valor</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>rvops-apikey</code></td>\n<td>Sua chave de API</td>\n</tr>\n</tbody>\n</table>\n</div><p>A API Key pode ser gerada e gerenciada dentro do CRM, na seção de configurações da conta.</p>\n<p><strong>Exemplo:</strong></p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>curl -X GET \"https://app.rvops.com/[CLIENT-ID]/api/v1/contacts\" \\\n  -H \"rvops-apikey: sua-api-key-aqui\"\n\n</code></pre><p><strong>Erros de autenticação:</strong></p>\n<ul>\n<li>Sem header ou API Key inválida: <code>401 Unauthorized</code></li>\n</ul>\n<hr>\n<h2 id=\"formato-de-resposta\">Formato de Resposta</h2>\n<h3 id=\"sucesso--listagem-e-busca-list--search\">Sucesso — Listagem e Busca (list / search)</h3>\n<p>Todos os endpoints de listagem e busca retornam a mesma estrutura:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"total\": 150,\n  \"results\": [\n    {\n      \"id\": 1,\n      \"properties\": {\n        \"firstname\": \"João\",\n        \"email\": \"joao@exemplo.com\"\n      }\n    }\n  ],\n  \"cursor\": {\n    \"next\": \"MTY4Nzg2ODQwMDAwMHw5ODI=\",\n    \"nextLink\": \"?cursor=MTY4Nzg2ODQwMDAwMHw5ODI=\"\n  },\n  \"hasMore\": true\n}\n\n</code></pre>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Campo</th>\n<th>Tipo</th>\n<th>Descrição</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>total</code></td>\n<td>number</td>\n<td>Total de registros encontrados</td>\n</tr>\n<tr>\n<td><code>results</code></td>\n<td>array</td>\n<td>Array com os objetos retornados</td>\n</tr>\n<tr>\n<td><code>cursor.next</code></td>\n<td>string</td>\n<td>Cursor para a próxima página (vazio se não houver)</td>\n</tr>\n<tr>\n<td><code>cursor.nextLink</code></td>\n<td>string</td>\n<td>Query string pronta para usar na próxima requisição</td>\n</tr>\n<tr>\n<td><code>hasMore</code></td>\n<td>boolean</td>\n<td><code>true</code> se existem mais páginas</td>\n</tr>\n</tbody>\n</table>\n</div><h3 id=\"sucesso--criação-create\">Sucesso — Criação (create)</h3>\n<p>Endpoints de criação retornam status <code>201 Created</code> com a seguinte estrutura:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"id\": 123,\n  \"properties\": {\n    \"firstname\": \"João\",\n    \"email\": \"joao@exemplo.com\"\n  },\n  \"associations\": {\n    \"deals\": [],\n    \"companies\": []\n  },\n  \"createdAt\": \"2026-03-15T12:00:00.000Z\",\n  \"updatedAt\": \"2026-03-15T12:00:00.000Z\"\n}\n\n</code></pre>\n<h3 id=\"erro\">Erro</h3>\n<p>Todas as respostas de erro seguem a mesma estrutura:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"category\": \"BadRequestError\",\n  \"message\": \"Descrição do erro\",\n  \"timestamp\": \"2026-03-15T12:00:00.000Z\",\n  \"status\": \"error\"\n}\n\n</code></pre>\n<p><strong>Códigos de erro possíveis:</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Código</th>\n<th>Categoria</th>\n<th>Descrição</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>400</code></td>\n<td>BadRequestError</td>\n<td>Requisição malformada ou parâmetros inválidos</td>\n</tr>\n<tr>\n<td><code>401</code></td>\n<td>UnauthorizedError</td>\n<td>Credenciais inválidas ou ausentes</td>\n</tr>\n<tr>\n<td><code>402</code></td>\n<td>LimitExceededError</td>\n<td>Limite do plano atingido</td>\n</tr>\n<tr>\n<td><code>403</code></td>\n<td>ForbiddenError</td>\n<td>Sem permissão para acessar o recurso</td>\n</tr>\n<tr>\n<td><code>404</code></td>\n<td>NotFoundError</td>\n<td>Recurso não encontrado</td>\n</tr>\n<tr>\n<td><code>409</code></td>\n<td>ConflictError</td>\n<td>Conflito com estado atual do recurso (ex: registro duplicado)</td>\n</tr>\n<tr>\n<td><code>422</code></td>\n<td>SemanticError</td>\n<td>Requisição bem formada mas com erros semânticos</td>\n</tr>\n<tr>\n<td><code>429</code></td>\n<td>ManyRequestError</td>\n<td>Rate limit excedido</td>\n</tr>\n<tr>\n<td><code>500</code></td>\n<td>InternalError</td>\n<td>Erro interno do servidor</td>\n</tr>\n</tbody>\n</table>\n</div><hr>\n<h2 id=\"paginação\">Paginação</h2>\n<p>A API utiliza paginação baseada em <strong>cursor</strong>. Os parâmetros são passados via query string:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parâmetro</th>\n<th>Tipo</th>\n<th>Default</th>\n<th>Máximo</th>\n<th>Descrição</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>limit</code></td>\n<td>number</td>\n<td>20</td>\n<td>100</td>\n<td>Quantidade de registros por página</td>\n</tr>\n<tr>\n<td><code>cursor</code></td>\n<td>string</td>\n<td>—</td>\n<td>—</td>\n<td>Cursor da próxima página (retornado no campo <code>cursor.next</code>)</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>Como paginar:</strong></p>\n<ol>\n<li><p>Faça a primeira requisição sem o parâmetro <code>cursor</code></p>\n</li>\n<li><p>Se <code>hasMore</code> for <code>true</code>, use o valor de <code>cursor.next</code> como parâmetro <code>cursor</code> na próxima requisição</p>\n</li>\n<li><p>Repita até <code>hasMore</code> ser <code>false</code></p>\n</li>\n</ol>\n<p><strong>Exemplo:</strong></p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>GET /api/v1/contacts?limit=50\nGET /api/v1/contacts?limit=50&amp;cursor=MTY4Nzg2ODQwMDAwMHw5ODI=\n\n</code></pre><hr>\n<h2 id=\"ordenação\">Ordenação</h2>\n<p>Todos os endpoints de listagem e busca suportam os seguintes parâmetros de ordenação via query string:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parâmetro</th>\n<th>Valores aceitos</th>\n<th>Default</th>\n<th>Descrição</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>sort</code></td>\n<td><code>date_modified</code>, <code>date_added</code>, <code>createdAt</code>, <code>updatedAt</code></td>\n<td><code>date_modified</code></td>\n<td>Campo de ordenação</td>\n</tr>\n<tr>\n<td><code>order</code></td>\n<td><code>desc</code>, <code>asc</code></td>\n<td><code>desc</code></td>\n<td>Direção da ordenação</td>\n</tr>\n</tbody>\n</table>\n</div><hr>\n<h2 id=\"criação-em-lote-batch-create\">Criação em Lote (Batch Create)</h2>\n<p>Os endpoints de criação em lote permitem criar múltiplos registros em uma única requisição. Disponível para Contatos, Negócios e Empresas.</p>\n<p><strong>Endpoints:</strong></p>\n<ul>\n<li><p><code>POST /api/v1/contacts/batch/create</code></p>\n</li>\n<li><p><code>POST /api/v1/deals/batch/create</code></p>\n</li>\n<li><p><code>POST /api/v1/companies/batch/create</code></p>\n</li>\n</ul>\n<p><strong>Formato do body:</strong></p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"inputs\": [\n    {\n      \"properties\": {\n        \"firstname\": \"João\",\n        \"email\": \"joao@exemplo.com\"\n      },\n      \"associations\": {\n        \"deals\": [1],\n        \"companies\": [2]\n      }\n    },\n    {\n      \"properties\": {\n        \"firstname\": \"Maria\",\n        \"email\": \"maria@exemplo.com\"\n      }\n    }\n  ]\n}\n\n</code></pre>\n<p>O campo <code>associations</code> é opcional em cada item. As mesmas regras de propriedades obrigatórias do create individual se aplicam.</p>\n<p><strong>Resposta:</strong> Status <code>201 Created</code> com array dos objetos criados.</p>\n<hr>\n<h2 id=\"operators-filtros-de-busca\">Operators (Filtros de Busca)</h2>\n<p>Os endpoints de <strong>search</strong> utilizam filtros para buscar registros com base nos valores das propriedades. Os filtros são passados como um array de objetos dentro do campo <code>filters</code>. Cada objeto no array é tratado como uma condição <strong>E</strong> (AND). Não há suporte para condição <strong>OU</strong> (OR).</p>\n<h3 id=\"estrutura-do-filtro\">Estrutura do filtro</h3>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"filters\": [\n        {\n            \"propertyName\": \"nome_da_propriedade\",\n            \"operator\": \"OPERADOR\",\n            \"value\": \"valor\"\n        }\n    ]\n}\n\n</code></pre>\n<h3 id=\"operadores-disponíveis\">Operadores disponíveis</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Operador</th>\n<th>Descrição</th>\n<th>Campo de valor</th>\n<th>Tipo</th>\n<th>Exemplo</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>EQ</code></td>\n<td>Igual a</td>\n<td><code>value</code></td>\n<td>string</td>\n<td><code>\"value\": \"São Paulo\"</code></td>\n</tr>\n<tr>\n<td><code>NEQ</code></td>\n<td>Diferente de</td>\n<td><code>value</code></td>\n<td>string</td>\n<td><code>\"value\": \"São Paulo\"</code></td>\n</tr>\n<tr>\n<td><code>GT</code></td>\n<td>Maior que</td>\n<td><code>value</code></td>\n<td>string</td>\n<td><code>\"value\": \"100\"</code></td>\n</tr>\n<tr>\n<td><code>GTE</code></td>\n<td>Maior ou igual a</td>\n<td><code>value</code></td>\n<td>string</td>\n<td><code>\"value\": \"100\"</code></td>\n</tr>\n<tr>\n<td><code>LT</code></td>\n<td>Menor que</td>\n<td><code>value</code></td>\n<td>string</td>\n<td><code>\"value\": \"50\"</code></td>\n</tr>\n<tr>\n<td><code>LTE</code></td>\n<td>Menor ou igual a</td>\n<td><code>value</code></td>\n<td>string</td>\n<td><code>\"value\": \"50\"</code></td>\n</tr>\n<tr>\n<td><code>IN</code></td>\n<td>Contido em uma lista</td>\n<td><code>values</code></td>\n<td>array</td>\n<td><code>\"values\": [\"1\", \"2\", \"3\"]</code></td>\n</tr>\n<tr>\n<td><code>NOT_IN</code></td>\n<td>Não contido em uma lista</td>\n<td><code>values</code></td>\n<td>array</td>\n<td><code>\"values\": [\"1\", \"2\"]</code></td>\n</tr>\n<tr>\n<td><code>HAS_PROPERTY</code></td>\n<td>Propriedade existe (tem valor)</td>\n<td>—</td>\n<td>—</td>\n<td>sem campo de valor</td>\n</tr>\n<tr>\n<td><code>NOT_HAS_PROPERTY</code></td>\n<td>Propriedade não existe (sem valor)</td>\n<td>—</td>\n<td>—</td>\n<td>sem campo de valor</td>\n</tr>\n<tr>\n<td><code>CONTAINS_TOKEN</code></td>\n<td>Contém a palavra (busca parcial)</td>\n<td><code>value</code></td>\n<td>string</td>\n<td><code>\"value\": \"Paulo\"</code></td>\n</tr>\n<tr>\n<td><code>NOT_CONTAINS_TOKEN</code></td>\n<td>Não contém a palavra</td>\n<td><code>value</code></td>\n<td>string</td>\n<td><code>\"value\": \"Paulo\"</code></td>\n</tr>\n</tbody>\n</table>\n</div><h3 id=\"regras-importantes\">Regras importantes</h3>\n<ul>\n<li><p><strong><code>EQ</code>****,</strong> <strong><code>NEQ</code>****,</strong> <strong><code>GT</code>****,</strong> <strong><code>GTE</code>****,</strong> <strong><code>LT</code>****,</strong> <strong><code>LTE</code>****,</strong> <strong><code>CONTAINS_TOKEN</code>****,</strong> <strong><code>NOT_CONTAINS_TOKEN</code></strong>: usam o campo <code>value</code> com tipo <strong>string</strong>.</p>\n</li>\n<li><p><strong><code>IN</code>****,</strong> <strong><code>NOT_IN</code></strong>: usam o campo <code>values</code> com tipo <strong>array de strings</strong>.</p>\n</li>\n<li><p><strong><code>HAS_PROPERTY</code>****,</strong> <strong><code>NOT_HAS_PROPERTY</code></strong>: <strong>não precisam de campo de valor</strong>. Apenas verificam se a propriedade possui ou não algum valor preenchido.</p>\n</li>\n<li><p><strong><code>CONTAINS_TOKEN</code></strong>: realiza busca parcial (equivalente a SQL <code>LIKE %valor%</code>). Exemplo: <code>\"value\": \"Paulo\"</code> encontra \"São Paulo\", \"Paulorama\", etc.</p>\n</li>\n<li><p><strong><code>NEQ</code></strong>: também retorna registros onde a propriedade é nula (não preenchida).</p>\n</li>\n<li><p><strong>Campos</strong> <strong><code>date</code></strong> <strong>e</strong> <strong><code>datetime</code></strong>: a comparação é feita apenas pela data (ignora hora). O valor deve estar no formato <code>YYYY-MM-DD</code> ou <code>YYYY-MM-DD HH:mm</code>.</p>\n</li>\n<li><p><strong>Campos</strong> <strong><code>number</code></strong> <strong>e</strong> <strong><code>currency</code></strong>: comparação numérica direta.</p>\n</li>\n<li><p><strong>Múltiplos filtros</strong>: todos os filtros no array são combinados com <strong>AND</strong>. Não há suporte para <strong>OR</strong> entre filtros.</p>\n</li>\n</ul>\n</body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"14009453","collectionId":"c0b601ae-c2c1-4153-a6b0-49f6b5144e2f","publishedId":"2sBXigMZPC","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-03-15T17:10:21.000Z"},"item":[{"name":"Contacts","item":[{"name":"search","id":"b2cd5de0-7a3c-4ab8-ae5e-b40d9c81881e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"filters\": [\n        {\n          \"value\": \"São Paulo\",\n          \"propertyName\": \"state\",\n          \"operator\": \"EQ\"\n        }\n      ],\n      \"properties\": [\"owner_id\"]\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/contacts/search","description":"<p>Pesquise por contatos com base nos valores das propriedades.</p>\n<p><strong>Filters:</strong><br />Filtros que você deseja aplicar na sua busca devem ser passados como um array de objetos, podendo conter uma ou mais opções. Cada novo objeto no array será tratado como uma condição <strong>E</strong>. O campo <code>Filters</code> é obrigatório. Exemplo:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"filters\": [\n    {\n      \"value\": \"São Paulo\",\n      \"propertyName\": \"state\",\n      \"operator\": \"EQ\"\n    },\n    {\n      \"values\": [\"2\", \"3\"],\n      \"propertyName\": \"points\",\n      \"operator\": \"IN\"\n    }\n  ]\n}\n</code></pre>\n<blockquote>\n<p>Para consultar todos os operadores disponíveis, suas regras e exemplos, veja a seção <strong>Operators (Filtros de Busca)</strong> na descrição principal desta collection.</p>\n</blockquote>\n<p><strong>Properties:</strong><br />Propriedades adicionais que você deseja incluir no retorno da sua busca devem ser passadas como um array. Exemplo: <code>[\"points\", \"state\"]</code>. O campo <code>Properties</code> é opcional; se não for informado, o retorno trará apenas as propriedades padrão.</p>\n<p><strong>Parâmetros opcionais:</strong></p>\n<ul>\n<li><p><strong>sort</strong>: Campo utilizado para ordenar os itens. Os campos disponíveis são: <code>date_modified</code>, <code>date_added</code>, <code>createdAt</code> e <code>updatedAt</code>. O padrão é <code>date_modified</code>.</p>\n</li>\n<li><p><strong>order</strong>: Direção da ordenação, podendo ser <strong>decrescente</strong> (<code>desc</code>) ou <strong>ascendente</strong> (<code>asc</code>). O padrão é <strong>decrescente</strong> (<code>desc</code>).</p>\n</li>\n</ul>\n","urlObject":{"path":["api","v1","contacts","search"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"b2cd5de0-7a3c-4ab8-ae5e-b40d9c81881e"},{"name":"read","id":"33933c4a-21b0-40c8-85b8-525bf67d774e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"GET","header":[],"url":"/api/v1/contacts/[contactId]","description":"<p>Retorna o contato informado junto com todas as propriedades e objetos associados, como Empresas e Negócios. Para isso, é obrigatório fornecer o ID do contato.</p>\n","urlObject":{"path":["api","v1","contacts","[contactId]"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"33933c4a-21b0-40c8-85b8-525bf67d774e"},{"name":"create","id":"7c63f59c-6562-4576-82dc-3f489ae7742b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"properties\": {\n        \"firstname\": \"Example name\",\n        \"email\": \"email@example.com\"\n    },\n    \"associations\": {\n\t\t\"deals\": [1],\n        \"companies\": [2, 3]\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/contacts","description":"<p>Cria o contato com as propriedades fornecidas e retorna uma cópia do objeto com todas as propriedades e o ID. É necessário informar as propriedades configuradas como obrigatórias.</p>\n<p>Você também pode incluir associações com Negócios e Empresas, embora isso não seja obrigatório.</p>\n<p><strong>Importante:</strong></p>\n<ul>\n<li><p>Propriedades do tipo MultiSelect devem ser informadas em forma de array, contendo os valores internos das opções escolhidas. Exemplo: <code>[\"valor1\", \"valor2\"]</code>.</p>\n</li>\n<li><p>Propriedades do tipo Date e DateTime devem ser passadas no formato <code>YYYY-MM-DD HH:mm</code>.</p>\n</li>\n<li><p>Os demais tipos de propriedades podem ser passadas como string.</p>\n</li>\n</ul>\n","urlObject":{"path":["api","v1","contacts"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"7c63f59c-6562-4576-82dc-3f489ae7742b"},{"name":"delete","id":"d0160e2f-c8e9-4f9e-a9f9-db3e919b1909","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"DELETE","header":[],"url":"/api/v1/contacts/[contactId]","description":"<p>Deleta um contato a partir de seu ID. Isso também apagará todas as suas propriedades e associações com outros objetos (mas os objetos em si não serão excluídos).</p>\n<p>Um contato apagado não pode ser recuperado.</p>\n","urlObject":{"path":["api","v1","contacts","[contactId]"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"d0160e2f-c8e9-4f9e-a9f9-db3e919b1909"},{"name":"update","id":"3854158f-1256-4c80-90b1-105e9a1bbe97","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n\t\"properties\": {\n\t\t\"age\": \"22\",\n        \"state\": null\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/contacts/[contactId]","description":"<p>Atualiza o contato com base no ID fornecido. Os valores das propriedades serão sobrescritos com os novos valores fornecidos. Para apagar o valor de uma propriedade, basta informá-la como <code>null</code>. Propriedades somente leitura e inexistentes serão ignoradas, e não é possível associar objetos durante a atualização.</p>\n<p><strong>Importante:</strong></p>\n<ul>\n<li><p>Propriedades do tipo MultiSelect devem ser informadas em forma de array, contendo os valores internos das opções escolhidas. Exemplo: <code>[\"valor1\", \"valor2\"]</code>.</p>\n</li>\n<li><p>Propriedades do tipo Date e DateTime devem ser passadas no formato <code>YYYY-MM-DD HH:mm</code>.</p>\n</li>\n<li><p>Os demais tipos de propriedades podem ser passadas como string.</p>\n</li>\n</ul>\n","urlObject":{"path":["api","v1","contacts","[contactId]"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"3854158f-1256-4c80-90b1-105e9a1bbe97"},{"name":"list","id":"38016d67-9342-4ed4-8a3f-4e2bdd11feb9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"GET","header":[],"url":"/api/v1/contacts?limit=2&cursor=MTY4Nzg2ODQwMDAwMHw5ODI=&campaignId=1&segmentId=1&properties=owner_id, age","description":"<p>Lista todos os contatos, limitando a 100 contatos por chamada. Existem alguns parâmetros opcionais que podem ser utilizados:</p>\n<ul>\n<li><p><strong>Limit</strong>: Limita a quantidade de contatos listados, com um mínimo de 1 e máximo de 100.</p>\n</li>\n<li><p><strong>Cursor</strong>: Cursor da próxima página da requisição, retornado sempre que houver mais contatos além dos exibidos até o momento.</p>\n</li>\n<li><p><strong>CampaignId</strong>: ID do fluxo de automação, retorna os contatos que atendem aos requisitos desse fluxo. O ID pode ser obtido dentro do CRM.</p>\n</li>\n<li><p><strong>SegmentId</strong>: ID do segmento, retorna os contatos que pertencem a esse segmento. O ID pode ser obtido dentro do CRM.</p>\n</li>\n<li><p><strong>Properties</strong>: Nome interno das propriedades extras que deseja trazer. Pode informar quantas desejar; caso não informe nenhuma, serão retornadas apenas as propriedades padrão.</p>\n</li>\n<li><p><strong>sort</strong>: Campo utilizado para ordenar os itens. Os campos disponíveis são: <code>date_modified</code>, <code>date_added</code>, <code>createdAt</code> e <code>updatedAt</code>. O padrão é <code>date_modified</code>.</p>\n</li>\n<li><p><strong>order</strong>: Direção da ordenação, podendo ser <strong>decrescente</strong> (<code>desc</code>) ou <strong>ascendente</strong> (<code>asc</code>). O padrão é <strong>decrescente</strong> (<code>desc</code>).</p>\n</li>\n<li><p><strong>includeAssociations:</strong> Define se os objetos associados devem ser incluídos na resposta da requisição.</p>\n<ul>\n<li><p>Se <code>true</code>: Os objetos associados serão listados junto ao objeto principal.</p>\n</li>\n<li><p>Se <code>false</code> ou <strong>não informado</strong>: Os objetos associados não serão listados.</p>\n</li>\n</ul>\n</li>\n</ul>\n<p><strong>Importante:</strong></p>\n<ul>\n<li>Se <strong>CampaignId</strong> e <strong>SegmentId</strong> forem informados na mesma requisição, serão retornados os contatos que existem em comum entre o Fluxo e o Segmento.</li>\n</ul>\n","urlObject":{"path":["api","v1","contacts"],"host":[""],"query":[{"key":"limit","value":"2"},{"key":"cursor","value":"MTY4Nzg2ODQwMDAwMHw5ODI="},{"description":{"content":"<p>ID do Fluxo de Automação</p>\n","type":"text/plain"},"key":"campaignId","value":"1"},{"description":{"content":"<p>ID do Segmento</p>\n","type":"text/plain"},"key":"segmentId","value":"1"},{"description":{"content":"<p>Propriedades para visualização</p>\n","type":"text/plain"},"key":"properties","value":"owner_id, age"}],"variable":[]}},"response":[],"_postman_id":"38016d67-9342-4ed4-8a3f-4e2bdd11feb9"},{"name":"search by cellphone","id":"48df7425-bc26-4958-8cc9-56252c5489d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"value\": \"+5511999999999\"\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/contacts/search-cellphone","description":"<p>Busca contatos por número de celular.</p>\n<p>Envie o número de celular no body da requisição para localizar contatos correspondentes.</p>\n","urlObject":{"path":["api","v1","contacts","search-cellphone"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"48df7425-bc26-4958-8cc9-56252c5489d3"},{"name":"batch create","id":"795cef90-42a3-4a9a-9b66-3f5f9367c07c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"inputs\": [\n        {\n            \"properties\": {\n                \"firstname\": \"Jo\\u00e3o\",\n                \"email\": \"joao@exemplo.com\"\n            }\n        },\n        {\n            \"properties\": {\n                \"firstname\": \"Maria\",\n                \"email\": \"maria@exemplo.com\"\n            }\n        }\n    ]\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/contacts/batch/create","description":"<p>Criação de contatos em lote (batch).</p>\n<p>Permite criar múltiplos contatos em uma única requisição. Envie um array de objetos no campo <code>inputs</code>, cada um contendo <code>properties</code> e opcionalmente <code>associations</code>.</p>\n<p>Para mais detalhes sobre o formato, consulte a seção <strong>Criação em Lote (Batch Create)</strong> na descrição principal desta collection.</p>\n","urlObject":{"path":["api","v1","contacts","batch","create"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"795cef90-42a3-4a9a-9b66-3f5f9367c07c"}],"id":"f1deb041-8357-4c93-a7be-2504dbfa21db","description":"<p>Na Rvops, os contatos armazenam informações sobre as pessoas que interagem com o seu negócio. Os endpoints de contatos permitem que você crie e gerencie registros de contatos em sua conta Rvops, bem como sincronize dados de contatos entre a Rvops e outros sistemas.</p>\n<p><a href=\"https://help.eloz.io/central-de-ajuda-eloz-crm/crm/contatos\">Clique aqui</a> para conhecer mais sobre o Objeto Contato</p>\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"dd0d415f-40d6-4e08-81a0-2f29cf8acbfd"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"dfdc8839-d321-4910-a5e9-0a7d4b5b8d93"}}],"_postman_id":"f1deb041-8357-4c93-a7be-2504dbfa21db"},{"name":"Deals","item":[{"name":"search","id":"f0cc0e92-8adb-4d53-971d-5f9ea1cc35f5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"filters\": [\n        {\n            \"values\": [\n                \"3\",\n                \"4\"\n            ],\n            \"propertyName\": \"xref_rd_id\",\n            \"operator\": \"IN\"\n        }\n    ],\n    \"properties\": [\n        \"owner_id\"\n    ]\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/deals/search","description":"<p>Pesquise por negócios com base nos valores das propriedades.</p>\n<p><strong>Filters:</strong><br />Filtros que você deseja aplicar na sua busca devem ser passados como um array de objetos, podendo conter uma ou mais opções. Cada novo objeto no array será tratado como uma condição <strong>E</strong>. O campo <code>Filters</code> é obrigatório. Exemplo:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"filters\": [\n    {\n      \"value\": \"10\",\n      \"propertyName\": \"amount\",\n      \"operator\": \"EQ\"\n    },\n    {\n      \"values\": [\"2\", \"3\"],\n      \"propertyName\": \"owner_id\",\n      \"operator\": \"IN\"\n    }\n  ]\n}\n</code></pre>\n<blockquote>\n<p>Para consultar todos os operadores disponíveis, suas regras e exemplos, veja a seção <strong>Operators (Filtros de Busca)</strong> na descrição principal desta collection.</p>\n</blockquote>\n<p><strong>Properties:</strong><br />Propriedades adicionais que você deseja incluir no retorno da sua busca devem ser passadas como um array. Exemplo: <code>[\"owner_id\", \"state\"]</code>. O campo <code>Properties</code> é opcional; se não for informado, o retorno trará apenas as propriedades padrão.</p>\n<p><strong>Parâmetros opcionais:</strong></p>\n<ul>\n<li><p><strong>sort</strong>: Campo utilizado para ordenar os itens. Os campos disponíveis são: <code>date_modified</code>, <code>date_added</code>, <code>createdAt</code> e <code>updatedAt</code>. O padrão é <code>date_modified</code>.</p>\n</li>\n<li><p><strong>order</strong>: Direção da ordenação, podendo ser <strong>decrescente</strong> (<code>desc</code>) ou <strong>ascendente</strong> (<code>asc</code>). O padrão é <strong>decrescente</strong> (<code>desc</code>).</p>\n</li>\n</ul>\n","urlObject":{"path":["api","v1","deals","search"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"f0cc0e92-8adb-4d53-971d-5f9ea1cc35f5"},{"name":"read","id":"b020a354-1707-4129-8a0c-e64c8a99b451","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"GET","header":[],"url":"/api/v1/deals/[id]","description":"<p>Retorna o negócio informado junto com todas as propriedades e objetos associados, como Empresas, Contatos e Produtos. Para isso, é obrigatório fornecer o ID do negócio.</p>\n","urlObject":{"path":["api","v1","deals","[id]"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"b020a354-1707-4129-8a0c-e64c8a99b451"},{"name":"create","id":"72506dce-3a80-47f2-a6d9-a0eb87eb00f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"properties\": {\n\t\t\"pipeline_id\": 1,\n\t\t\"stage_id\": 2,\n\t\t\"name\": \"Novo negócio\",\n\t\t\"priority\": \"1\",\n\t\t\"owner_id\": 2\n\t},\n\t\"associations\": {\n\t\t\"products\": [\n\t\t\t{\n\t\t\t\t\"id\": 1027,\n\t\t\t\t\"quantity\": 12,\n\t\t\t\t\"linePrice\": 100\n\t\t\t}\n\t\t],\n        \"contacts\": [1]\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/deals","description":"<p>Cria o negócio com as propriedades fornecidas e retorna uma cópia do objeto com todas as propriedades e o ID. É necessário informar as propriedades configuradas como obrigatórias.</p>\n<p>Você também pode incluir associações com Contatos, Empresas e Produtos, embora isso não seja obrigatório.</p>\n<p><strong>Importante:</strong></p>\n<ul>\n<li><p>Propriedades do tipo MultiSelect devem ser informadas em forma de array, contendo os valores internos das opções escolhidas. Exemplo: <code>[\"valor1\", \"valor2\"]</code>.</p>\n</li>\n<li><p>Propriedades do tipo Date e DateTime devem ser passadas no formato <code>YYYY-MM-DD HH:mm</code>.</p>\n</li>\n<li><p>Os demais tipos de propriedades podem ser passadas como string.</p>\n</li>\n</ul>\n","urlObject":{"path":["api","v1","deals"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"72506dce-3a80-47f2-a6d9-a0eb87eb00f9"},{"name":"delete","id":"87e8f06a-d5e3-4ac4-8088-8a8221770927","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"DELETE","header":[],"url":"/api/v1/deals/[id]","description":"<p>Deleta o negócio a partir de seu ID. Isso também apagará todas as suas propriedades e associações com outros objetos (mas os objetos em si não serão excluídos).</p>\n<p>O negócio apagado não pode ser recuperado.</p>\n","urlObject":{"path":["api","v1","deals","[id]"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"87e8f06a-d5e3-4ac4-8088-8a8221770927"},{"name":"update","id":"3ac0b3d7-cbcb-46f7-ba39-040cbf76e534","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n    \"properties\": {\n\t\t\"name\": \"Negócio atualizado\",\n\t\t\"priority\": \"2\"\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/deals/[dealId]","description":"<p>Atualiza o negócio com base no ID fornecido. Os valores das propriedades serão sobrescritos com os novos valores fornecidos. Para apagar o valor de uma propriedade, basta informá-la como <code>null</code>. Propriedades somente leitura e inexistentes serão ignoradas, e não é possível associar objetos durante a atualização.</p>\n<p><strong>Importante:</strong></p>\n<ul>\n<li><p>Propriedades do tipo MultiSelect devem ser informadas em forma de array, contendo os valores internos das opções escolhidas. Exemplo: <code>[\"valor1\", \"valor2\"]</code>.</p>\n</li>\n<li><p>Propriedades do tipo Date e DateTime devem ser passadas no formato <code>YYYY-MM-DD HH:mm</code>.</p>\n</li>\n<li><p>Os demais tipos de propriedades podem ser passadas como string.</p>\n</li>\n</ul>\n","urlObject":{"path":["api","v1","deals","[dealId]"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"3ac0b3d7-cbcb-46f7-ba39-040cbf76e534"},{"name":"list","id":"5d7056f7-218c-4c6c-8513-6db27848b072","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"GET","header":[],"url":"/api/v1/deals?limit=2&cursor=MTY4ODk5OTgwOTAwMHw5&properties=owner_id","description":"<p>Lista todos os negócios, limitando a 100 negócios por chamada. Existem alguns parâmetros opcionais que podem ser utilizados:</p>\n<ul>\n<li><p><strong>Limit</strong>: Limita a quantidade de contatos listados, com um mínimo de 1 e máximo de 100.</p>\n</li>\n<li><p><strong>Cursor</strong>: Cursor da próxima página da requisição, retornado sempre que houver mais negócios além dos exibidos até o momento.</p>\n</li>\n<li><p><strong>Properties</strong>: Nome interno das propriedades extras que deseja trazer. Pode informar quantas desejar; caso não informe nenhuma, serão retornadas apenas as propriedades padrão.</p>\n</li>\n<li><p><strong>sort</strong>: Campo utilizado para ordenar os itens. Os campos disponíveis são: <code>date_modified</code>, <code>date_added</code>, <code>createdAt</code> e <code>updatedAt</code>. O padrão é <code>date_modified</code>.</p>\n</li>\n<li><p><strong>order</strong>: Direção da ordenação, podendo ser <strong>decrescente</strong> (<code>desc</code>) ou <strong>ascendente</strong> (<code>asc</code>). O padrão é <strong>decrescente</strong> (<code>desc</code>).</p>\n</li>\n<li><p><strong>includeAssociations:</strong> Define se os objetos associados devem ser incluídos na resposta da requisição.</p>\n<ul>\n<li><p>Se <code>true</code>: Os objetos associados serão listados junto ao objeto principal.</p>\n</li>\n<li><p>Se <code>false</code> ou <strong>não informado</strong>: Os objetos associados não serão listados.</p>\n</li>\n</ul>\n</li>\n</ul>\n","urlObject":{"path":["api","v1","deals"],"host":[""],"query":[{"key":"limit","value":"2"},{"key":"cursor","value":"MTY4ODk5OTgwOTAwMHw5"},{"description":{"content":"<p>Propriedades para visualização</p>\n","type":"text/plain"},"key":"properties","value":"owner_id"}],"variable":[]}},"response":[],"_postman_id":"5d7056f7-218c-4c6c-8513-6db27848b072"},{"name":"replace Products","id":"066d6007-3479-48fa-9382-71f796fc9dff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"products\": [\n\t\t{\n\t\t\t\"productId\": 19,\n\t\t\t\"quantity\": \"2\",\n\t\t\t\"linePrice\": \"123\",\n\t\t\t\"isCustom\": 0\n\t\t},\n\t\t{\n\t\t\t\"quantity\": \"2\",\n\t\t\t\"linePrice\": \"100.50\",\n\t\t\t\"name\": \"Cria produto\",\n\t\t\t\"sku\": \"12345\",\n\t\t\t\"isCustom\": 1\n\t\t}\n\t]\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/deals/products/[id]","description":"<p>Esta API substitui todos os produtos atuais da negociação pelos novos produtos informados.</p>\n<p>Se desejar manter os produtos existentes, é necessário incluí-los no array de produtos junto com os novos, garantindo que a lista contenha tanto os antigos quanto os novos produtos.</p>\n<p>Na <strong>Rvops</strong>, existem dois tipos de produtos:</p>\n<ol>\n<li><p><strong>Produtos da biblioteca</strong> – Produtos previamente cadastrados na biblioteca de produtos. Para adicioná-los, informe:</p>\n<ol>\n<li><p><code>productId</code> (ID do produto na biblioteca)</p>\n</li>\n<li><p><code>quantity</code> (quantidade)</p>\n</li>\n<li><p><code>linePrice</code> (preço unitário)</p>\n</li>\n<li><p><code>isCustom</code> (0 para produtos da biblioteca, 1 para customizados)</p>\n</li>\n</ol>\n</li>\n<li><p><strong>Produtos customizados por negociação</strong> – Produtos que não precisam estar cadastrados na biblioteca. Para adicioná-los, informe:</p>\n<ul>\n<li><p><code>quantity</code> (quantidade)</p>\n</li>\n<li><p><code>linePrice</code> (preço unitário)</p>\n</li>\n<li><p><code>name</code> (nome do produto)</p>\n</li>\n<li><p><code>isCustom = 1</code> (indicando que é um produto customizado)</p>\n</li>\n<li><p><code>sku</code> (opcional)</p>\n</li>\n</ul>\n</li>\n</ol>\n<p>Exemplo:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"products\": [\n        {\n            \"productId\": 19,\n            \"quantity\": \"2\",\n            \"linePrice\": \"123\",\n            \"isCustom\": 0\n        },\n        {\n            \"quantity\": \"2\",\n            \"linePrice\": \"100.50\",\n            \"name\": \"Cria produto\",\n            \"sku\": \"12345\",\n            \"isCustom\": 1\n        }\n    ]\n}\n\n</code></pre>\n<p>O exemplo do <strong>body</strong> acima adicionará à negociação:</p>\n<ul>\n<li><p>2 unidades do produto da biblioteca com <strong>ID 19</strong>, com valor unitário de <strong>123</strong>.</p>\n</li>\n<li><p>Um produto customizado chamado <strong>\"Cria produto\"</strong>, com <strong>2 unidades</strong>, cada uma no valor de <strong>109,50</strong>, e <strong>SKU 123</strong>.</p>\n</li>\n</ul>\n<p><strong>Importante:</strong> Ao utilizar esta API para atualizar os produtos da negociação, o valor total da negociação será recalculado automaticamente com base nos valores unitários e quantidades dos produtos adicionados.</p>\n","urlObject":{"path":["api","v1","deals","products","[id]"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"066d6007-3479-48fa-9382-71f796fc9dff"},{"name":"batch create","id":"448d6ba8-ca6d-4c65-a0dc-21d7e4bcf570","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"inputs\": [\n        {\n            \"properties\": {\n                \"pipeline_id\": 1,\n                \"stage_id\": 2,\n                \"name\": \"Neg\\u00f3cio 1\"\n            }\n        },\n        {\n            \"properties\": {\n                \"pipeline_id\": 1,\n                \"stage_id\": 2,\n                \"name\": \"Neg\\u00f3cio 2\"\n            }\n        }\n    ]\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/deals/batch/create","description":"<p>Criação de negócios em lote (batch).</p>\n<p>Permite criar múltiplos negócios em uma única requisição. Envie um array de objetos no campo <code>inputs</code>, cada um contendo <code>properties</code> e opcionalmente <code>associations</code>.</p>\n<p>Para mais detalhes sobre o formato, consulte a seção <strong>Criação em Lote (Batch Create)</strong> na descrição principal desta collection.</p>\n","urlObject":{"path":["api","v1","deals","batch","create"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"448d6ba8-ca6d-4c65-a0dc-21d7e4bcf570"}],"id":"9b199e51-6e73-41c5-98ea-c6185aa3301a","description":"<p>Na Rvops, negócios representam transações com contatos ou empresas. Os negócios são acompanhados através do seu processo de vendas em etapas da pipeline até serem ganhos ou perdidos. Os endpoints de negócios permitem que você crie e gerencie registros de negócios, bem como sincronize dados de negócios entre a Rvops e outros sistemas.</p>\n<p><a href=\"https://help.eloz.io/central-de-ajuda-eloz-crm/crm/negocios\">Clique aqui</a> para conhecer mais sobre o Objeto Negócio.</p>\n","_postman_id":"9b199e51-6e73-41c5-98ea-c6185aa3301a"},{"name":"Companies","item":[{"name":"search","id":"4169fe7c-1041-47ce-a576-4f0c2d80210d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"filters\": [\n        {\n            \"values\": [\n                \"3\",\n                \"4\"\n            ],\n            \"propertyName\": \"xref_rd_id\",\n            \"operator\": \"IN\"\n        }\n    ]\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/companies/search","description":"<p>Pesquise por empresas com base nos valores das propriedades.</p>\n<p><strong>Filters:</strong><br />Filtros que você deseja aplicar na sua busca devem ser passados como um array de objetos, podendo conter uma ou mais opções. Cada novo objeto no array será tratado como uma condição <strong>E</strong>. O campo <code>Filters</code> é obrigatório. Exemplo:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"filters\": [\n    {\n      \"value\": \"São Paulo\",\n      \"propertyName\": \"companystate\",\n      \"operator\": \"EQ\"\n    },\n    {\n      \"values\": [\"2\", \"3\"],\n      \"propertyName\": \"owner_id\",\n      \"operator\": \"IN\"\n    }\n  ]\n}\n</code></pre>\n<blockquote>\n<p>Para consultar todos os operadores disponíveis, suas regras e exemplos, veja a seção <strong>Operators (Filtros de Busca)</strong> na descrição principal desta collection.</p>\n</blockquote>\n<p><strong>Properties:</strong><br />Propriedades adicionais que você deseja incluir no retorno da sua busca devem ser passadas como um array. Exemplo: <code>[\"owner_id\", \"companystate\"]</code>. O campo <code>Properties</code> é opcional; se não for informado, o retorno trará apenas as propriedades padrão.</p>\n<p><strong>Parâmetros opcionais:</strong></p>\n<ul>\n<li><p><strong>sort</strong>: Campo utilizado para ordenar os itens. Os campos disponíveis são: <code>date_modified</code>, <code>date_added</code>, <code>createdAt</code> e <code>updatedAt</code>. O padrão é <code>date_modified</code>.</p>\n</li>\n<li><p><strong>order</strong>: Direção da ordenação, podendo ser <strong>decrescente</strong> (<code>desc</code>) ou <strong>ascendente</strong> (<code>asc</code>). O padrão é <strong>decrescente</strong> (<code>desc</code>).</p>\n</li>\n</ul>\n","urlObject":{"path":["api","v1","companies","search"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"4169fe7c-1041-47ce-a576-4f0c2d80210d"},{"name":"read","id":"b8b2a418-eaea-4f71-b472-639eab110922","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"GET","header":[],"url":"/api/v1/companies/[id]","description":"<p>Retorna a empresa informada junto com todas as propriedades e objetos associados, como Contatos e Negócios. Para isso, é obrigatório fornecer o ID da empresa.</p>\n","urlObject":{"path":["api","v1","companies","[id]"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"b8b2a418-eaea-4f71-b472-639eab110922"},{"name":"create","id":"a649f224-5e33-46c2-8745-f50852589220","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"properties\": {\n\t\t\"companyname\": \"Eloz CRM\",\n        \"companywebsite\": \"https://eloz.io/\"\n\t},\n\t\"associations\": {\n\t\t\"contacts\": [1],\n\t\t\"deals\": [1]\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/companies","description":"<p>Cria a empresa com as propriedades fornecidas e retorna uma cópia do objeto com todas as propriedades e o ID. É necessário informar as propriedades configuradas como obrigatórias.</p>\n<p>Você também pode incluir associações com Contatos e Negócios, embora isso não seja obrigatório.</p>\n<p><strong>Importante:</strong></p>\n<ul>\n<li><p>Propriedades do tipo MultiSelect devem ser informadas em forma de array, contendo os valores internos das opções escolhidas. Exemplo: <code>[\"valor1\", \"valor2\"]</code>.</p>\n</li>\n<li><p>Propriedades do tipo Date e DateTime devem ser passadas no formato <code>YYYY-MM-DD HH:mm</code>.</p>\n</li>\n<li><p>Os demais tipos de propriedades podem ser passadas como string.</p>\n</li>\n</ul>\n","urlObject":{"path":["api","v1","companies"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"a649f224-5e33-46c2-8745-f50852589220"},{"name":"delete","id":"594c0394-9887-4187-81b8-75eb729df868","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"DELETE","header":[],"url":"/api/v1/companies/[ID]","description":"<p>Deleta a empresa a partir de seu ID. Isso também apagará todas as suas propriedades e associações com outros objetos (mas os objetos em si não serão excluídos).</p>\n<p>A empresa apagada não pode ser recuperada.</p>\n","urlObject":{"path":["api","v1","companies","[ID]"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"594c0394-9887-4187-81b8-75eb729df868"},{"name":"update","id":"bd75241e-4ebd-423a-bf87-9b306b8ec6c8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n\t\"properties\": {\n\t\t\"companyname\": \"Nome da empresa atualizado\"\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/companies/[companyId]","description":"<p>Atualiza a empresa com base no ID fornecido. Os valores das propriedades serão sobrescritos com os novos valores fornecidos. Para apagar o valor de uma propriedade, basta informá-la como <code>null</code>. Propriedades somente leitura e inexistentes serão ignoradas, e não é possível associar objetos durante a atualização.</p>\n<p><strong>Importante:</strong></p>\n<ul>\n<li><p>Propriedades do tipo MultiSelect devem ser informadas em forma de array, contendo os valores internos das opções escolhidas. Exemplo: <code>[\"valor1\", \"valor2\"]</code>.</p>\n</li>\n<li><p>Propriedades do tipo Date e DateTime devem ser passadas no formato <code>YYYY-MM-DD HH:mm</code>.</p>\n</li>\n<li><p>Os demais tipos de propriedades podem ser passadas como string.</p>\n</li>\n</ul>\n","urlObject":{"path":["api","v1","companies","[companyId]"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"bd75241e-4ebd-423a-bf87-9b306b8ec6c8"},{"name":"list","id":"c275f5ad-1735-4f92-88a8-24aa8abf34e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"GET","header":[],"url":"/api/v1/companies?limit=2&cursor=MTY4ODk5OTgwOTAwMHw5&properties=owner_id","description":"<p>Lista todas as empresas, limitando a 100 empresas por chamada. Existem alguns parâmetros opcionais que podem ser utilizados:</p>\n<ul>\n<li><p><strong>Limit</strong>: Limita a quantidade de contatos listados, com um mínimo de 1 e máximo de 100.</p>\n</li>\n<li><p><strong>Cursor</strong>: Cursor da próxima página da requisição, retornado sempre que houver mais empresas além dos exibidos até o momento.</p>\n</li>\n<li><p><strong>Properties</strong>: Nome interno das propriedades extras que deseja trazer. Pode informar quantas desejar; caso não informe nenhuma, serão retornadas apenas as propriedades padrão.</p>\n</li>\n<li><p><strong>sort</strong>: Campo utilizado para ordenar os itens. Os campos disponíveis são: <code>date_modified</code>, <code>date_added</code>, <code>createdAt</code> e <code>updatedAt</code>. O padrão é <code>date_modified</code>.</p>\n</li>\n<li><p><strong>order</strong>: Direção da ordenação, podendo ser <strong>decrescente</strong> (<code>desc</code>) ou <strong>ascendente</strong> (<code>asc</code>). O padrão é <strong>decrescente</strong> (<code>desc</code>).</p>\n</li>\n<li><p><strong>includeAssociations:</strong> Define se os objetos associados devem ser incluídos na resposta da requisição.</p>\n<ul>\n<li><p>Se <code>true</code>: Os objetos associados serão listados junto ao objeto principal.</p>\n</li>\n<li><p>Se <code>false</code> ou <strong>não informado</strong>: Os objetos associados não serão listados.</p>\n</li>\n</ul>\n</li>\n</ul>\n","urlObject":{"path":["api","v1","companies"],"host":[""],"query":[{"key":"limit","value":"2"},{"key":"cursor","value":"MTY4ODk5OTgwOTAwMHw5"},{"description":{"content":"<p>Propriedades para visualização</p>\n","type":"text/plain"},"key":"properties","value":"owner_id"}],"variable":[]}},"response":[],"_postman_id":"c275f5ad-1735-4f92-88a8-24aa8abf34e9"},{"name":"batch create","id":"184873c6-4d17-4119-b580-a00208056c26","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"inputs\": [\n        {\n            \"properties\": {\n                \"companyname\": \"Empresa 1\",\n                \"companydomain\": \"empresa1.com\"\n            }\n        },\n        {\n            \"properties\": {\n                \"companyname\": \"Empresa 2\",\n                \"companydomain\": \"empresa2.com\"\n            }\n        }\n    ]\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/companies/batch/create","description":"<p>Criação de empresas em lote (batch).</p>\n<p>Permite criar múltiplas empresas em uma única requisição. Envie um array de objetos no campo <code>inputs</code>, cada um contendo <code>properties</code> e opcionalmente <code>associations</code>.</p>\n<p>Para mais detalhes sobre o formato, consulte a seção <strong>Criação em Lote (Batch Create)</strong> na descrição principal desta collection.</p>\n","urlObject":{"path":["api","v1","companies","batch","create"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"184873c6-4d17-4119-b580-a00208056c26"}],"id":"28b6739f-a3b5-4baa-86cc-192b738b87d8","description":"<p>Na Rvops, as empresas armazenam informações sobre as organizações que interagem com o seu negócio e/ou contato. Os endpoints de empresas permitem que você crie e gerencie registros de empresas, bem como sincronize dados de empresas entre a Rvops e outros sistemas.</p>\n<p><a href=\"https://help.eloz.io/central-de-ajuda-eloz-crm/crm/empresas\">Clique aqui</a> para conhecer mais sobre o Objeto Empresas.</p>\n","_postman_id":"28b6739f-a3b5-4baa-86cc-192b738b87d8"},{"name":"Pipelines","item":[{"name":"create","id":"f9f04ebb-92ae-4cb4-bf1d-02f261270ae6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"value":"","key":"<key>"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"name\": \"Comercial\",\n\t\"stages\": [\n\t\t{\n\t\t\t\"name\": \"Estacionamento\",\n\t\t\t\"probability\": \"20\"\n\t\t},\n\t\t{\n\t\t\t\"name\": \"Finalizado\",\n\t\t\t\"probability\": \"100\"\n\t\t},\n\t\t{\n\t\t\t\"name\": \"Descontinuado\",\n\t\t\t\"probability\": \"0\"\n\t\t}\n\t]\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/deals/pipeline","description":"<p>Cria um <strong>pipeline</strong> junto com suas <strong>etapas</strong>.</p>\n<ul>\n<li><p>Para o <strong>pipeline</strong>, é necessário informar o <strong>nome</strong> (<code>name</code>).</p>\n</li>\n<li><p>Para as <strong>etapas</strong>, deve-se fornecer um <strong>array de objetos</strong>, onde cada objeto deve conter:</p>\n<ul>\n<li><p><code>name</code> (nome da etapa)</p>\n</li>\n<li><p><code>probability</code> (probabilidade da etapa)</p>\n</li>\n</ul>\n</li>\n</ul>\n<p><strong>Restrições:</strong></p>\n<ul>\n<li><p>O nome da pipeline e das etapas <strong>não pode conter</strong> os seguintes caracteres: <code>' \" { } / \\</code>.</p>\n</li>\n<li><p>A <strong>probabilidade das etapas</strong> deve ser sempre um múltiplo de <strong>10</strong>, variando de <strong>0 a 100</strong>.</p>\n</li>\n<li><p><strong>Não são aceitos</strong> valores fracionados, negativos ou acima de <strong>100</strong>.</p>\n</li>\n</ul>\n","urlObject":{"path":["api","v1","deals","pipeline"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"f9f04ebb-92ae-4cb4-bf1d-02f261270ae6"},{"name":"list","id":"312fe50a-00bd-4f7d-add6-304be9a4c5bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"value":"","key":"<key>"},"isInherited":false},"method":"GET","header":[],"url":"/api/v1/deals/pipelines","description":"<p>Retorno de todas as pipelines de negócios com suas respectivas etapas.</p>\n","urlObject":{"path":["api","v1","deals","pipelines"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"312fe50a-00bd-4f7d-add6-304be9a4c5bc"}],"id":"52e07d70-df40-455a-99de-1b835675571d","_postman_id":"52e07d70-df40-455a-99de-1b835675571d","description":""},{"name":"Products","item":[{"name":"search","id":"185dcf63-f5cb-460c-b25b-5d3f163c0f84","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"filters\": [\n        {\n          \"value\": \"Produto 1\",\n          \"propertyName\": \"name\",\n          \"operator\": \"EQ\"\n        }\n      ]\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/products/search","description":"<p>Pesquise por produtos com base nos valores das propriedades.</p>\n<p>Por não ser possível criar novas propriedades para produtos, as opções de filtro são limitadas às seguintes:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Value</strong></th>\n<th><strong>Descrição</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><strong>id</strong></td>\n<td>ID do produto</td>\n</tr>\n<tr>\n<td><strong>name</strong></td>\n<td>Nome do produto</td>\n</tr>\n<tr>\n<td><strong>price</strong></td>\n<td>Preço do produto</td>\n</tr>\n<tr>\n<td><strong>sku</strong></td>\n<td>Código SKU do produto</td>\n</tr>\n<tr>\n<td><strong>frequency</strong></td>\n<td>Frequência de cobrança do produto</td>\n</tr>\n<tr>\n<td><strong>unit_cost</strong></td>\n<td>Custo unitário do produto</td>\n</tr>\n<tr>\n<td><strong>url</strong></td>\n<td>URL do produto</td>\n</tr>\n<tr>\n<td><strong>months_term</strong></td>\n<td>Prazo em meses para a renovação do produto</td>\n</tr>\n<tr>\n<td><strong>description</strong></td>\n<td>Descrição do produto</td>\n</tr>\n<tr>\n<td><strong>updatedAt</strong></td>\n<td>Data e hora da última atualização do produto</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>Filters:</strong><br />Filtros que você deseja aplicar na sua busca devem ser passados como um array de objetos, podendo conter uma ou mais opções. Cada novo objeto no array será tratado como uma condição <strong>E</strong>. O campo <code>Filters</code> é obrigatório. Exemplo:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">jsonCopy code{\n  \"filters\": [\n    {\n      \"value\": \"Produto 1\",\n      \"propertyName\": \"name\",\n      \"operator\": \"EQ\"\n    },\n    {\n      \"values\": [\"20\", \"50\"],\n      \"propertyName\": \"unit_cost\",\n      \"operator\": \"IN\"\n    }\n  ]\n}\n\n</code></pre>\n<p>Isso significa que a busca retornará os produtos em que o nome seja igual a Produto 1 <strong>e</strong> o custo unitário seja igual a 20 ou 50.</p>\n<blockquote>\n<p>Para consultar todos os operadores disponíveis, suas regras e exemplos, veja a seção <strong>Operators (Filtros de Busca)</strong> na descrição principal desta collection.</p>\n</blockquote>\n<p><strong>Parâmetros opcionais:</strong></p>\n<ul>\n<li><p><strong>sort</strong>: Campo utilizado para ordenar os itens. Os campos disponíveis são: <code>date_modified</code>, <code>date_added</code>, <code>createdAt</code> e <code>updatedAt</code>. O padrão é <code>date_modified</code>.</p>\n</li>\n<li><p><strong>order</strong>: Direção da ordenação, podendo ser <strong>decrescente</strong> (<code>desc</code>) ou <strong>ascendente</strong> (<code>asc</code>). O padrão é <strong>decrescente</strong> (<code>desc</code>).</p>\n</li>\n</ul>\n","urlObject":{"path":["api","v1","products","search"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"185dcf63-f5cb-460c-b25b-5d3f163c0f84"},{"name":"read","id":"e111c3e7-5413-47fb-bf80-f8f7d69dd090","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"GET","header":[],"url":"/api/v1/products/[id]","description":"<p>Retorna o produto informado junto com todas as propriedades. Para isso, é obrigatório fornecer o ID do produto.</p>\n","urlObject":{"path":["api","v1","products","[id]"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"e111c3e7-5413-47fb-bf80-f8f7d69dd090"},{"name":"create","id":"49b4aa67-98f3-4524-96ad-f7230a08b40f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"properties\": {\n        \"name\": \"Novo Produto\",\n        \"price\": 99.90,\n        \"sku\": \"1234\"\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/products","description":"<p>Crie um produto com as propriedades fornecidas e retorne uma cópia do objeto, incluindo o ID.</p>\n<p>Por não ser possível criar novas propriedades para produtos, elas são limitadas às seguintes:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Value</strong></th>\n<th><strong>Descrição</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><strong>id</strong></td>\n<td>ID do produto</td>\n</tr>\n<tr>\n<td><strong>name</strong></td>\n<td>Nome do produto</td>\n</tr>\n<tr>\n<td><strong>price</strong></td>\n<td>Preço do produto</td>\n</tr>\n<tr>\n<td><strong>sku</strong></td>\n<td>Código SKU do produto</td>\n</tr>\n<tr>\n<td><strong>frequency</strong></td>\n<td>Frequência de cobrança do produto</td>\n</tr>\n<tr>\n<td><strong>unit_cost</strong></td>\n<td>Custo unitário do produto</td>\n</tr>\n<tr>\n<td><strong>url</strong></td>\n<td>URL do produto</td>\n</tr>\n<tr>\n<td><strong>months_term</strong></td>\n<td>Prazo em meses para a renovação do produto</td>\n</tr>\n<tr>\n<td><strong>description</strong></td>\n<td>Descrição do produto</td>\n</tr>\n<tr>\n<td><strong>updatedAt</strong></td>\n<td>Data e hora da última atualização do produto</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["api","v1","products"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"49b4aa67-98f3-4524-96ad-f7230a08b40f"},{"name":"delete","id":"a4b22b9e-b8ef-4508-8d3a-95ee500692fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"DELETE","header":[],"url":"/api/v1/products/[id]","description":"<p>Deleta o produto a partir de seu ID. Isso também apagará todas as suas associações com outros objetos (mas os objetos em si não serão excluídos).</p>\n<p>Um produto apagado não pode ser recuperado.</p>\n","urlObject":{"path":["api","v1","products","[id]"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"a4b22b9e-b8ef-4508-8d3a-95ee500692fd"},{"name":"update","id":"e78c913c-51b2-4010-9942-e5cb7707641e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n    \"properties\": {\n        \"name\": \"Produto atualizado\"\n    }\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/products/[productId]","description":"<p>Atualiza o produto com base no ID fornecido. Os valores das propriedades serão sobrescritos com os novos valores fornecidos. Para apagar o valor de uma propriedade, basta informá-la como <code>null</code>. Propriedades somente leitura e inexistentes serão ignoradas, e não é possível associar objetos durante a atualização.</p>\n<p><strong>Importante:</strong></p>\n<ul>\n<li><p>Propriedades do tipo MultiSelect devem ser informadas em forma de array, contendo os valores internos das opções escolhidas. Exemplo: <code>[\"valor1\", \"valor2\"]</code>.</p>\n</li>\n<li><p>Propriedades do tipo Date e DateTime devem ser passadas no formato <code>YYYY-MM-DD HH:mm</code>.</p>\n</li>\n<li><p>Os demais tipos de propriedades podem ser passadas como string.</p>\n</li>\n</ul>\n","urlObject":{"path":["api","v1","products","[productId]"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"e78c913c-51b2-4010-9942-e5cb7707641e"},{"name":"list","id":"1bc319f0-5502-40ef-b074-b06a78ffb272","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"GET","header":[],"url":"/api/v1/products?limit=2&cursor=MTY4ODk5OTgwOTAwMHw5","description":"<p>Lista todos os produtos, limitando a 100 produtos por chamada. Existem alguns parâmetros opcionais que podem ser utilizados:</p>\n<ul>\n<li><p><strong>Limit</strong>: Limita a quantidade de produtos listados, com um mínimo de 1 e máximo de 100.</p>\n</li>\n<li><p><strong>Cursor</strong>: Cursor da próxima página da requisição, retornado sempre que houver mais produtos além dos exibidos até o momento.</p>\n</li>\n<li><p><strong>sort</strong>: Campo utilizado para ordenar os itens. Os campos disponíveis são: <code>date_modified</code>, <code>date_added</code>, <code>createdAt</code> e <code>updatedAt</code>. O padrão é <code>date_modified</code>.</p>\n</li>\n<li><p><strong>order</strong>: Direção da ordenação, podendo ser <strong>decrescente</strong> (<code>desc</code>) ou <strong>ascendente</strong> (<code>asc</code>). O padrão é <strong>decrescente</strong> (<code>desc</code>).</p>\n</li>\n</ul>\n","urlObject":{"path":["api","v1","products"],"host":[""],"query":[{"key":"limit","value":"2"},{"key":"cursor","value":"MTY4ODk5OTgwOTAwMHw5"}],"variable":[]}},"response":[],"_postman_id":"1bc319f0-5502-40ef-b074-b06a78ffb272"}],"id":"057b0ca9-7158-4105-b875-a696aadb1f04","description":"<p>Na Rvops, produtos representam os bens ou serviços que você vende. Construir uma biblioteca de produtos permite adicionar rapidamente produtos a negócios. Os endpoints de produtos permitem que você gerencie esses dados e os sincronize entre a Rvops e outros sistemas.</p>\n<p>Exemplo de caso de uso: para que os representantes de vendas possam adicionar facilmente bens e serviços a negócios, cotações e mais, use a API de produtos para importar seu catálogo de produtos na Rvops.</p>\n<p><a href=\"https://help.eloz.io/central-de-ajuda-eloz-crm/crm/produtos\">Clique aqui</a> para conhecer mais sobre Produtos.</p>\n","_postman_id":"057b0ca9-7158-4105-b875-a696aadb1f04"},{"name":"Notes","item":[{"name":"list","id":"def2b948-a5cd-4fad-a3e0-51c2695ceb8e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"GET","header":[],"url":"/api/v1/notes/[fromObject]/[fromObjectId]","description":"<p>Lista as anotações do objeto informado, juntamente com o ID. Os objetos disponíveis são:</p>\n<ul>\n<li><p>deal</p>\n</li>\n<li><p>contact</p>\n</li>\n</ul>\n","urlObject":{"path":["api","v1","notes","[fromObject]","[fromObjectId]"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"d351683e-8364-4882-801d-77fd85d0a6e0","name":"read","originalRequest":{"method":"GET","header":[],"url":"/api/v1/notes/[fromObject]/[fromObjectId]"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"110"},{"key":"ETag","value":"W/\"6e-nfvIYn92XrMvwXJzmTrHIBxz1N0\""},{"key":"Date","value":"Fri, 01 Sep 2023 12:59:26 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"[\n    {\n        \"id\": 6,\n        \"timestamp\": \"2023-09-01T12:52:53.000Z\",\n        \"object\": \"leads\",\n        \"object_id\": 9,\n        \"owner\": 1,\n        \"body\": \"My Example\"\n    }\n]"}],"_postman_id":"def2b948-a5cd-4fad-a3e0-51c2695ceb8e"},{"name":"create","id":"6ca876d6-6add-4002-a05d-bb9114cd2880","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"properties\": {\n        \"text\": \"Uma anotação de exemplo\",\n        \"type\": \"general\",\n\t\t\"files\": [\n\t\t\t{\n\t\t\t\t\"link\": \"https://link-arquivo.com/1\",\n\t\t\t\t\"name\": \"nome arquivo\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"link\": \"https://link-arquivo.com/2\"\n\t\t\t}\n\t\t]\n    }\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/notes/[fromObject]/[fromObjectId]","description":"<p>Cria uma anotação para o objeto com o ID fornecido e retorna uma cópia do objeto, incluindo o ID da anotação. Os objetos disponíveis são:</p>\n<ul>\n<li><p>deal</p>\n</li>\n<li><p>contact</p>\n</li>\n</ul>\n<p>E as opções para o campo <code>type</code> são:</p>\n<ul>\n<li><p>general</p>\n</li>\n<li><p>email</p>\n</li>\n<li><p>call</p>\n</li>\n<li><p>meeting</p>\n</li>\n<li><p>whatsapp</p>\n</li>\n</ul>\n<p>Opcionalmente, também é possível fornecer um array de objetos contendo um link e, opcionalmente, um nome de arquivo.</p>\n","urlObject":{"path":["api","v1","notes","[fromObject]","[fromObjectId]"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"6ca876d6-6add-4002-a05d-bb9114cd2880"},{"name":"delete","id":"315a0f02-e2a2-4d66-b2da-cb215d7459a4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"DELETE","header":[],"url":"/api/v1/notes/[noteId]","description":"<p>Ao deletar uma anotação, o registro correspondente será removido da timeline do contato ou negócio.</p>\n<p>Anotações deletadas não podem ser recuperadas.</p>\n","urlObject":{"path":["api","v1","notes","[noteId]"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"315a0f02-e2a2-4d66-b2da-cb215d7459a4"}],"id":"10d2eab5-3939-43b9-98b2-871dc90e1e98","description":"<p>Você pode registrar notas em registros da Rvops para adicionar informações à linha do tempo do registro. Por exemplo, se você precisar acompanhar uma conversa offline que teve com um contato, pode adicionar uma nota ao registro de contato com os detalhes relacionados à conversa. Outros usuários na conta poderão então visualizar e referenciar essa nota.</p>\n","_postman_id":"10d2eab5-3939-43b9-98b2-871dc90e1e98"},{"name":"Tasks","item":[{"name":"search","id":"d9feba7a-f2ac-46e3-a85d-e67b2faae26f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"filters\": [\n        {\n            \"value\": \"Tarefa 1\",\n            \"propertyName\": \"name\",\n            \"operator\": \"EQ\"\n        },\n        {\n            \"values\": [\n                \"2\",\n                \"0\"\n            ],\n            \"propertyName\": \"priority\",\n            \"operator\": \"IN\"\n        }\n    ]\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/tasks/search","description":"<p>Pesquise por tarefas com base nos valores das propriedades.</p>\n<p>Por não ser possível criar novas propriedades para tarefas, as opções de filtro são limitadas às seguintes:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Value</strong></th>\n<th><strong>Descrição</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><strong>id</strong></td>\n<td>ID da tarefa</td>\n</tr>\n<tr>\n<td><strong>name</strong></td>\n<td>Nome/título da tarefa</td>\n</tr>\n<tr>\n<td><strong>due_date</strong></td>\n<td>Data e hora do vencimento da tarefa</td>\n</tr>\n<tr>\n<td><strong>owner_id</strong></td>\n<td>ID do proprietário da tarefa</td>\n</tr>\n<tr>\n<td><strong>task_type</strong></td>\n<td>Tipo da tarefa (todo, call, email ou whatsapp)</td>\n</tr>\n<tr>\n<td><strong>source</strong></td>\n<td>Origem da tarefa</td>\n</tr>\n<tr>\n<td><strong>description</strong></td>\n<td>Descrição da tarefa</td>\n</tr>\n<tr>\n<td><strong>priority</strong></td>\n<td>Prioridade da tarefa (valores aceitos: 0, 1 ou 2, onde 0 = baixa, 1 = média e 2 = alta).</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>Filters:</strong><br />Filtros que você deseja aplicar na sua busca devem ser passados como um array de objetos, podendo conter uma ou mais opções. Cada novo objeto no array será tratado como uma condição <strong>E</strong>. O campo <code>Filters</code> é obrigatório. Exemplo:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">jsonCopy code{\n  \"filters\": [\n    {\n      \"value\": \"Tarefa 1\",\n      \"propertyName\": \"name\",\n      \"operator\": \"EQ\"\n    },\n    {\n      \"values\": [\"2\", \"0\"],\n      \"propertyName\": \"priority\",\n      \"operator\": \"IN\"\n    }\n  ]\n}\n\n</code></pre>\n<p>Isso significa que a busca retornará as tarefas em que o nome seja igual a Tarefa 1 <strong>e</strong> a prioridade seja igual a 2 (alta) ou 0 (baixa).</p>\n<blockquote>\n<p>Para consultar todos os operadores disponíveis, suas regras e exemplos, veja a seção <strong>Operators (Filtros de Busca)</strong> na descrição principal desta collection.</p>\n</blockquote>\n<p><strong>Parâmetros opcionais:</strong></p>\n<ul>\n<li><p><strong>sort</strong>: Campo utilizado para ordenar os itens. Os campos disponíveis são: <code>date_modified</code>, <code>date_added</code>, <code>createdAt</code> e <code>updatedAt</code>. O padrão é <code>date_modified</code>.</p>\n</li>\n<li><p><strong>order</strong>: Direção da ordenação, podendo ser <strong>decrescente</strong> (<code>desc</code>) ou <strong>ascendente</strong> (<code>asc</code>). O padrão é <strong>decrescente</strong> (<code>desc</code>).</p>\n</li>\n</ul>\n","urlObject":{"path":["api","v1","tasks","search"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"d9feba7a-f2ac-46e3-a85d-e67b2faae26f"},{"name":"read","id":"700f81e2-2820-4a0c-9c1b-ee566665bec7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"GET","header":[],"url":"/api/v1/tasks/[id]","description":"<p>Lista as propriedades da tarefa associada ao ID fornecido.</p>\n","urlObject":{"path":["api","v1","tasks","[id]"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"700f81e2-2820-4a0c-9c1b-ee566665bec7"},{"name":"create","id":"5f9ace18-ece8-43fd-83af-4e2343c6d817","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"properties\": {\n\t\t\"name\": \"Nova tarefa\",\n\t\t\"owner\": 2,\n\t\t\"description\": \"Apenas um lembrete\",\n\t\t\"due_date\": \"2024-06-25\",\n        \"due_time\": \"12:00\",\n\t\t\"task_type\": \"todo\",\n\t\t\"priority\": \"0\",\n\t\t\"source\": \"Meu usuário\"\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/tasks","description":"<p>Cria uma tarefa com as propriedades e associações fornecidas e retorna uma cópia do objeto, incluindo o ID. Não é obrigatório, mas você pode associar a tarefa aos seguintes objetos:</p>\n<ul>\n<li><p>deals</p>\n</li>\n<li><p>contacts</p>\n</li>\n</ul>\n<p>Ambos os objetos são passados em um array (dentro do campo \"properties\") contendo os IDs que deseja associar à tarefa, por exemplo:<br /><code>deals[]: [\"5\", \"12\"]</code></p>\n<p><code>contacts[]: [\"12345\"]</code></p>\n","urlObject":{"path":["api","v1","tasks"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"5f9ace18-ece8-43fd-83af-4e2343c6d817"},{"name":"delete","id":"23221f23-8136-4493-ad15-52bcf9445417","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"DELETE","header":[],"url":"/api/v1/tasks/[id]","description":"<p>Deleta a tarefa a partir de seu ID. Isso também apagará todas as suas associações com outros objetos (mas os objetos em si não serão excluídos).</p>\n<p>Uma tarefa apagada não pode ser recuperada.</p>\n","urlObject":{"path":["api","v1","tasks","[id]"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"23221f23-8136-4493-ad15-52bcf9445417"},{"name":"update","id":"4e109f50-b855-414c-be6a-835a7fc6e71a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n    \"properties\": {\n        \"name\": \"Tarefa Atualizada\",\n        \"owner\": \"2\",\n        \"description\": \"Mudando descrição\",\n        \"due_date\": \"2024-06-25 15:00\",\n        \"task_type\": \"todo\",\n        \"priority\": \"0\",\n        \"source\": \"Meu usuário\"\n    }\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/tasks/[taskId]","description":"<p>Atualiza a tarefa com base no ID fornecido. Os valores das propriedades serão sobrescritos com os novos valores fornecidos. Para apagar o valor de uma propriedade, basta informá-la como <code>null</code>. Propriedades somente leitura e inexistentes serão ignoradas, e não é possível associar objetos durante a atualização.</p>\n<p><strong>Importante:</strong></p>\n<ul>\n<li><p>Propriedades do tipo Date e DateTime devem ser passadas no formato <code>YYYY-MM-DD HH:mm</code>.</p>\n</li>\n<li><p>Os demais tipos de propriedades podem ser passadas como string.</p>\n</li>\n</ul>\n","urlObject":{"path":["api","v1","tasks","[taskId]"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"4e109f50-b855-414c-be6a-835a7fc6e71a"},{"name":"list","id":"6040ce20-de21-4296-af8b-d5b10a44fd67","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"GET","header":[],"url":"/api/v1/tasks?limit=2&cursor=MTY4ODk5OTgwOTAwMHw5","description":"<p>Lista todas as tarefas, limitando a 100 tarefas por chamada. Existem alguns parâmetros opcionais que podem ser utilizados:</p>\n<ul>\n<li><p><strong>Limit</strong>: Limita a quantidade de tarefas listadas, com um mínimo de 1 e máximo de 100.</p>\n</li>\n<li><p><strong>Cursor</strong>: Cursor da próxima página da requisição, retornado sempre que houver mais tarefas além dos exibidos até o momento.</p>\n</li>\n<li><p><strong>sort</strong>: Campo utilizado para ordenar os itens. Os campos disponíveis são: <code>date_modified</code>, <code>date_added</code>, <code>createdAt</code> e <code>updatedAt</code>. O padrão é <code>date_modified</code>.</p>\n</li>\n<li><p><strong>order</strong>: Direção da ordenação, podendo ser <strong>decrescente</strong> (<code>desc</code>) ou <strong>ascendente</strong> (<code>asc</code>). O padrão é <strong>decrescente</strong> (<code>desc</code>).</p>\n</li>\n</ul>\n","urlObject":{"path":["api","v1","tasks"],"host":[""],"query":[{"key":"limit","value":"2"},{"key":"cursor","value":"MTY4ODk5OTgwOTAwMHw5"}],"variable":[]}},"response":[],"_postman_id":"6040ce20-de21-4296-af8b-d5b10a44fd67"}],"id":"78930611-a374-498c-a35f-88d009015b24","description":"<p>Use a API de tarefas para criar e gerenciar tarefas. Você pode criar tarefas na Rvops ou através da API de tarefas.</p>\n<p><a href=\"https://help.eloz.io/central-de-ajuda-eloz-crm/crm/tarefas\">Clique aqui</a> para conhecer mais sobre Tarefa.</p>\n","_postman_id":"78930611-a374-498c-a35f-88d009015b24"},{"name":"Associations","item":[{"name":"create","id":"2e667bce-fa1b-4c92-aebf-c036d3071663","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"POST","header":[],"url":"/api/v1/associations/[fromObject]/[fromObjectId]/[toObject]/[toObjectId]","description":"<p>Cria uma associação entre objetos, sendo necessário informar o tipo do objeto e o ID. Os tipos de objetos disponíveis são:</p>\n<ul>\n<li><p>deal</p>\n</li>\n<li><p>contact</p>\n</li>\n<li><p>company</p>\n</li>\n<li><p>tag</p>\n</li>\n<li><p>product (funcionando apenas de deal -&gt; product)</p>\n<ul>\n<li><p>Necessário utilizar body request para associar produto à um negócio. Exemplo abaixo:</p>\n<ul>\n<li>\"data\": {\"quantity\": 1,\"linePrice\" : \"10.99\",\"forceUpdateAmount\": true // quantity * linePrice = valor total do negócio}</li>\n</ul>\n</li>\n</ul>\n</li>\n</ul>\n<p><strong>Importante:</strong><br />Não é possível criar associações entre objetos do mesmo tipo!</p>\n","urlObject":{"path":["api","v1","associations","[fromObject]","[fromObjectId]","[toObject]","[toObjectId]"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"2e667bce-fa1b-4c92-aebf-c036d3071663"},{"name":"delete","id":"d33a633d-f07d-48c7-8e27-02139c561286","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"DELETE","header":[],"url":"/api/v1/associations/[fromObject]/[fromObjectId]/[toObject]/[toObjectId]","description":"<p>Remove as associações entre os objetos com os IDs fornecidos. As associações removidas não podem ser recuperadas, sendo necessário criar uma nova, se desejado. Os tipos de objetos disponíveis são:</p>\n<ul>\n<li><p>deal</p>\n</li>\n<li><p>contact</p>\n</li>\n<li><p>company</p>\n</li>\n</ul>\n","urlObject":{"path":["api","v1","associations","[fromObject]","[fromObjectId]","[toObject]","[toObjectId]"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"d33a633d-f07d-48c7-8e27-02139c561286"}],"id":"20a07bbe-2556-4383-9b2d-1c546a0f845c","description":"<p>As associações representam os relacionamentos entre objetos da Rvops. As associações de registros podem existir entre registros de diferentes objetos (por exemplo, Contato para Empresa). Você pode usar os endpoints de associações para criar ou excluir associações entre registros.</p>\n","_postman_id":"20a07bbe-2556-4383-9b2d-1c546a0f845c"},{"name":"Properties","item":[{"name":"create","id":"112622ae-dd8b-4e2b-8b9e-54b956771724","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"properties\": {\n\t\t\"name\": \"Idade\",\n\t\t\"group\": \"core\",\n\t\t\"object\": \"contact\",\n\t\t\"type\": \"number\",\n\t\t\"isRequired\": true,\n\t\t\"isUniqueIdentifier\": false\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/properties","description":"<p>Cria uma nova propriedade do tipo especificado no objeto informado. Os objetos disponíveis são:</p>\n<ul>\n<li><p>contact</p>\n</li>\n<li><p>company</p>\n</li>\n<li><p>deal</p>\n</li>\n</ul>\n<p>E os tipos disponíveis são:</p>\n<ul>\n<li><p>date</p>\n</li>\n<li><p>datetime</p>\n</li>\n<li><p>select</p>\n</li>\n<li><p>multiselect</p>\n</li>\n<li><p>text</p>\n</li>\n<li><p>textarea</p>\n</li>\n<li><p>time</p>\n</li>\n<li><p>number</p>\n</li>\n<li><p>user</p>\n</li>\n<li><p>currency</p>\n</li>\n</ul>\n<p><strong>Properties:</strong><br />Obrigatório apenas para os tipos <strong>select</strong> e <strong>multiselect</strong>. Recebe uma lista com o <strong>label</strong> e <strong>value</strong> das opções que deseja criar. O <strong>label</strong> é o nome de exibição para os usuários e o <strong>value</strong> é o valor interno.</p>\n<p><strong>isFormVisible:</strong><br />Valor booleano (<code>false</code> ou <code>true</code>), opcional; quando definido como <code>true</code>, o campo é exibido no formulário do objeto, exceto para negociações.</p>\n<p>Exemplo:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">jsonCopy code{\n    \"properties\": {\n        \"name\": \"Prop Multiselect\",\n        \"group\": \"core\",\n        \"object\": \"contact\",\n        \"type\": \"multiselect\",\n        \"properties\": {\n            \"list\": [\n                {\n                    \"label\": \"Valor 1\",\n                    \"value\": \"valor1\"\n                },\n                {\n                    \"label\": \"Valor 2\",\n                    \"value\": \"valor2\"\n                }\n            ]\n        },\n        \"isRequired\": false,\n        \"isUniqueIdentifier\": false,\n        \"isFormVisible\": false\n    }\n}\n\n</code></pre>\n","urlObject":{"path":["api","v1","properties"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"112622ae-dd8b-4e2b-8b9e-54b956771724"},{"name":"list","id":"5527af4f-8eb6-4ed6-a447-fef0f1cdf8d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"GET","header":[],"url":"/api/v1/properties/[object]","description":"<p>Liste todas as propriedades existentes para o tipo de objeto especificado. Os objetos disponíveis são:</p>\n<ul>\n<li><p>deal</p>\n</li>\n<li><p>contact</p>\n</li>\n<li><p>company</p>\n</li>\n</ul>\n","urlObject":{"path":["api","v1","properties","[object]"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"5527af4f-8eb6-4ed6-a447-fef0f1cdf8d0"}],"id":"73d8dd80-776d-40ec-ae03-f7582c44ae65","description":"<p>Use propriedades para armazenar informações em registros na Rvops. A Rvops fornece um conjunto de propriedades padrão para cada objeto, e você também pode criar e gerenciar suas próprias propriedades personalizadas, seja na Rvops ou usando a API de propriedades.</p>\n<p>Ao criar propriedades, é importante considerar como arquitetar seus dados.</p>\n<p><a href=\"https://help.eloz.io/central-de-ajuda-eloz-crm/conta-e-configuracao/propriedades\">Clique aqui</a> para conhecer mais sobre as Propriedades.</p>\n","_postman_id":"73d8dd80-776d-40ec-ae03-f7582c44ae65"},{"name":"Segments","item":[{"name":"list","id":"bf04ae89-da75-4612-95a5-12abebb694ed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"GET","header":[],"url":"/api/v1/segments?limit=2&cursor=MTY4Nzg2ODQwMDAwMHw5ODI=&sort=date_added&order=desc","description":"<p>Lista todos os segmentos, limitando a 100 segmentos por chamada. Existem alguns parâmetros opcionais que podem ser utilizados:</p>\n<ul>\n<li><p><strong>Limit</strong>: Limita a quantidade de segmentos listados, com um mínimo de 1 e máximo de 100.</p>\n</li>\n<li><p><strong>Cursor</strong>: Cursor da próxima página da requisição, retornado sempre que houver mais segmentos além dos exibidos até o momento.</p>\n</li>\n<li><p><strong>Sort</strong>: Campo utilizado para ordenar os resultados. As opções são <code>date_added</code> ou <code>date_modified</code>. O valor padrão é <code>date_added</code>.</p>\n</li>\n<li><p><strong>Order</strong>: Define a ordem da listagem. Pode ser <code>desc</code> (decrescente) ou <code>asc</code> (crescente). O valor padrão é <code>desc</code>.</p>\n</li>\n</ul>\n","urlObject":{"path":["api","v1","segments"],"host":[""],"query":[{"key":"limit","value":"2"},{"key":"cursor","value":"MTY4Nzg2ODQwMDAwMHw5ODI="},{"description":{"content":"<p>Campo utilizado para ordenar. Por padrão usamos date_added.</p>\n","type":"text/plain"},"key":"sort","value":"date_added"},{"description":{"content":"<p>Tipo de ordenação, pode ser desc ou asc. Por padrão usamos desc.</p>\n","type":"text/plain"},"key":"order","value":"desc"}],"variable":[]}},"response":[],"_postman_id":"bf04ae89-da75-4612-95a5-12abebb694ed"},{"name":"create","id":"a7e31e87-9a62-4ca0-9628-a50eb1274ce1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"properties\": {\n\t\t\"name\": \"Segmento 1\",\n\t\t\"description\": \"Segmento criado por API\"\n\t},\n\t\t\"contacts\": [1, 2, 5, 10]\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/segments","description":"<p>Cria um novo segmento com as propriedades fornecidas e retorna uma cópia do objeto contendo todas as propriedades, além do ID gerado. É obrigatório informar as propriedades marcadas como obrigatórias.</p>\n<p>Opcionalmente, você pode incluir contatos no segmento, mas isso não é necessário.</p>\n","urlObject":{"path":["api","v1","segments"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"a7e31e87-9a62-4ca0-9628-a50eb1274ce1"},{"name":"add a contact","id":"e4c03d7f-4224-4ab3-9853-fc67e36d526a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"POST","header":[],"url":"/api/v1/segments/[segmentId]/add/[contactId]","description":"<p>Adiciona um único contato a um segmento existente. Para isso, é necessário fornecer o ID do segmento e o ID do contato que deseja adicionar.</p>\n","urlObject":{"path":["api","v1","segments","[segmentId]","add","[contactId]"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"e4c03d7f-4224-4ab3-9853-fc67e36d526a"},{"name":"add contacts","id":"95dc2604-7723-419b-93a2-814024540f74","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"contacts\": [1, 2, 5, 10]\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/segments/[segmentId]/add","description":"<p>Adiciona vários contatos a um segmento existente. Para isso, é necessário fornecer o ID do segmento e um array com os IDs dos contatos que deseja adicionar no corpo da requisição.</p>\n","urlObject":{"path":["api","v1","segments","[segmentId]","add"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"95dc2604-7723-419b-93a2-814024540f74"}],"id":"088896d3-74ec-4da8-9b12-72767c69a74a","description":"<p>Segmentos referem-se à prática de dividir sua base de clientes ou leads em grupos menores e mais específicos, com base em características comuns. Esses segmentos ajudam as empresas a personalizar suas estratégias de marketing, vendas, ou ações específicas.</p>\n<p>Atualmente, a criação de segmentos via API está limitada a segmentos do tipo estático e sem filtros. Isso significa que o segmento só conterá os contatos que forem adicionados manualmente, seja pela Rvops ou via API.</p>\n<p><a href=\"https://help.eloz.io/central-de-ajuda-eloz-crm/crm/contatos/como-criar-um-segmento\">Clique aqui</a> para conhecer mais sobre os Segmentos.</p>\n","_postman_id":"088896d3-74ec-4da8-9b12-72767c69a74a"},{"name":"Automation Flows","item":[{"name":"add contacts","id":"70cdf427-0214-4bc9-bc10-1461c0e4806e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"ids\": [\n        \"1\"\n    ],\n    \"campaign\": \"1\"\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/contacts/add-to-campaign","description":"<p>Adiciona um ou mais contatos a um Fluxo de Automação, desde que o fluxo esteja ativo.</p>\n<p>Os campos esperados no corpo da requisição são:</p>\n<ul>\n<li><p><strong>leads</strong>: Array contendo os IDs dos contatos a serem inscritos.</p>\n</li>\n<li><p><strong>campaign</strong>: ID do fluxo de automação no qual os contatos serão inscritos.</p>\n</li>\n</ul>\n","urlObject":{"path":["api","v1","contacts","add-to-campaign"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"70cdf427-0214-4bc9-bc10-1461c0e4806e"},{"name":"add deals","id":"ae65b965-f790-4bc9-8b32-9d4fb4b91ddc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"ids\": [\n        \"1\",\n        \"2\"\n    ],\n    \"campaign\": \"1\"\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/deals/add-to-campaign","description":"<p>Adiciona negócios a um fluxo de automação.</p>\n<p>Envie um array de IDs de negócios no campo <code>ids</code> e o ID do fluxo no campo <code>campaign</code>.</p>\n<blockquote>\n<p><strong>Nota:</strong> O campo padrão é <code>ids</code>. O campo legado <code>deals</code> também é aceito como fallback.</p>\n</blockquote>\n","urlObject":{"path":["api","v1","deals","add-to-campaign"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"ae65b965-f790-4bc9-8b32-9d4fb4b91ddc"}],"id":"e673f90b-e121-4cf6-84e4-b0961766d672","description":"<p>Fluxos de automação, são conjuntos de instruções que automatizam processos repetitivos ou sistemáticos em uma organização, eliminando a necessidade de intervenção manual em várias etapas. Ajudando a facilitar tarefas, e otimizando o tempo.</p>\n<p><a href=\"https://help.eloz.io/central-de-ajuda-rvops-crm/fluxos-de-automacao/fluxos-de-automacao\">Clique aqui</a> para conhecer mais sobre os Fluxos de Automação.</p>\n","_postman_id":"e673f90b-e121-4cf6-84e4-b0961766d672"},{"name":"Forms","item":[{"name":"list","id":"815b0d52-6d7e-4cf0-ac58-bf1201e9870e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"GET","header":[],"url":"/api/v1/forms?limit=2&cursor=MTY4Nzg2ODQwMDAwMHw5ODI=","description":"<p>Lista todos os formulários, incluindo seus campos. Para campos do tipo Select, Multiselect, Radio ou Checkbox, as opções também são listadas. Campos do tipo Quebra de Página incluem os nomes dos botões \"Avançar\" e \"Voltar\". O limite é de 100 formulários por chamada.</p>\n<p>Parâmetros opcionais disponíveis:</p>\n<ul>\n<li><p><strong>Limit</strong>: Limita a quantidade de formulários listados, com um mínimo de 1 e máximo de 100.</p>\n</li>\n<li><p><strong>Cursor</strong>: Cursor da próxima página da requisição, retornado sempre que houver mais segmentos além dos exibidos até o momento.</p>\n</li>\n</ul>\n","urlObject":{"path":["api","v1","forms"],"host":[""],"query":[{"key":"limit","value":"2"},{"key":"cursor","value":"MTY4Nzg2ODQwMDAwMHw5ODI="}],"variable":[]}},"response":[],"_postman_id":"815b0d52-6d7e-4cf0-ac58-bf1201e9870e"},{"name":"read","id":"063d25e8-b4cc-498a-aa20-a7d44a154b95","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"GET","header":[],"url":"/api/v1/forms/[formId]","description":"<p>Retorna o formulário informado junto com todos os campos. Para campos do tipo Select, Multiselect, Radio ou Checkbox, as opções também são listadas. Campos do tipo Quebra de Página incluem os nomes dos botões \"Avançar\" e \"Voltar\". Para isso, é obrigatório fornecer o ID do formulário.</p>\n","urlObject":{"path":["api","v1","forms","[formId]"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"063d25e8-b4cc-498a-aa20-a7d44a154b95"}],"id":"2cb8af24-684f-4629-8dcb-63f2708828ec","_postman_id":"2cb8af24-684f-4629-8dcb-63f2708828ec","description":""},{"name":"Users","item":[{"name":"list","id":"6f05961a-723a-4587-ae8c-bd91612b4bba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"GET","header":[],"url":"/api/v1/users","description":"<p>Lista todos os usuários da conta.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Campo</strong></th>\n<th><strong>Valor/tipo</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>id</td>\n<td>Número (id do usuário)</td>\n</tr>\n<tr>\n<td>name</td>\n<td>Texto (nome completo do usuário)</td>\n</tr>\n<tr>\n<td>email</td>\n<td>Texto (email do usuário)</td>\n</tr>\n<tr>\n<td>phoneNumber</td>\n<td>Texto (telefone do usuário padrão E.164)</td>\n</tr>\n<tr>\n<td>isSuperAdmin</td>\n<td>Boolean (diz se usuário é ou não super admin)</td>\n</tr>\n<tr>\n<td>teamIds</td>\n<td>Array (id das equipes que usuário faz parte)</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["api","v1","users"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"6f05961a-723a-4587-ae8c-bd91612b4bba"},{"name":"create","id":"541d45c5-70cb-4bde-94b0-4a9cb3404338","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"properties\": {\n        \"name\": \"Novo Usu\\u00e1rio\",\n        \"email\": \"usuario@exemplo.com\"\n    }\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/users","description":"<p>Cria um novo usuário na conta.</p>\n","urlObject":{"path":["api","v1","users"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"541d45c5-70cb-4bde-94b0-4a9cb3404338"}],"id":"d6a7f9d2-51c0-4b80-9ff6-b58975011401","_postman_id":"d6a7f9d2-51c0-4b80-9ff6-b58975011401","description":""},{"name":"Teams","item":[{"name":"list","id":"b43f60d0-f8b4-46f9-951d-580296abcac4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"GET","header":[],"url":"/api/v1/teams","description":"<p>Lista todas as equipes da conta.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Campo</strong></th>\n<th><strong>Valor/tipo</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>id</td>\n<td>Número (id da equipe)</td>\n</tr>\n<tr>\n<td>name</td>\n<td>Texto (nome da equipe)</td>\n</tr>\n<tr>\n<td>quantity_users</td>\n<td>Número (quantidade de usuários na equipe)</td>\n</tr>\n<tr>\n<td>created_at</td>\n<td>Data (data de criação)</td>\n</tr>\n<tr>\n<td>users</td>\n<td>Array (id dos usuários da equipe)</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["api","v1","teams"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"b43f60d0-f8b4-46f9-951d-580296abcac4"},{"name":"create","id":"390d52ef-0664-4c48-98b4-07ff5508cf14","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"properties\": {\n        \"name\": \"Nova equipe\"\n    }\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/teams","description":"<p>Cria uma nova equipe na conta.</p>\n","urlObject":{"path":["api","v1","teams"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"390d52ef-0664-4c48-98b4-07ff5508cf14"},{"name":"remove users","id":"6e440574-9f4f-42ae-b1de-a6bc837ea393","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"properties\": {\n\t\t\"teamId\": 2,\n\t\t\"users\": [3]\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/teams/remove-members","description":"<p>Remove usuários da equipe</p>\n","urlObject":{"path":["api","v1","teams","remove-members"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"6e440574-9f4f-42ae-b1de-a6bc837ea393"},{"name":"add users","id":"f9b0c198-78e0-4ab3-af0d-eb34709b4514","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"properties\": {\n\t\t\"teamId\": 2,\n\t\t\"users\": [1,2]\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/teams/add-members","description":"<p>Adiciona usuários na equipe</p>\n","urlObject":{"path":["api","v1","teams","add-members"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"f9b0c198-78e0-4ab3-af0d-eb34709b4514"}],"id":"9b2e0577-1384-4e49-8902-eefd1c3126de","_postman_id":"9b2e0577-1384-4e49-8902-eefd1c3126de","description":""},{"name":"Files","item":[{"name":"upload","id":"84f2258b-655c-4e46-8195-9f5029f58787","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","value":""}]},"url":"/api/v1/files/[object]/[objectId]","description":"<p>Upload de arquivo vinculado a um objeto.</p>\n<p>Envie o arquivo no campo <code>file</code> usando <code>multipart/form-data</code>.</p>\n<p><strong>Parâmetros de URL:</strong></p>\n<ul>\n<li><code>object</code> — tipo do objeto (contact, deal, company, etc.)</li>\n<li><code>objectId</code> — ID do objeto ao qual o arquivo será vinculado</li>\n</ul>\n<p><strong>Exemplo:</strong> <code>POST /api/v1/files/contact/123</code> — vincula o arquivo ao contato de ID 123.</p>\n","urlObject":{"path":["api","v1","files","[object]","[objectId]"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"84f2258b-655c-4e46-8195-9f5029f58787"}],"id":"f5a777c1-4ad4-4a5c-8c9e-04a9bfafa32c","_postman_id":"f5a777c1-4ad4-4a5c-8c9e-04a9bfafa32c","description":""},{"name":"Communications (BETA)","item":[{"name":"Envio de Template de Whatsapp","id":"cea90f31-27a8-4254-8519-68f51af3bc4b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"variables\": [\"Felipe\"],\n\t\"number_to\": \"5519989405029\",\n\t\"number_from\": \"5511961599895\",\n\t\"insert_event\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://server.spread.chat/api/template/send/[idTemplateRvops]","description":"<p>Permite o envio direto do template para o contato utilizando o número de celular.</p>\n<p>Atualmente, a chave de acesso está sendo gerada internamente, sendo necessário solicitá-la.</p>\n<p><strong>Parâmetros do corpo:</strong></p>\n<ul>\n<li><p><strong>variables</strong>: valores a serem substituídos no conteúdo do template. É necessário passar um array de strings, onde cada posição será substituída conforme a ordem do array.</p>\n</li>\n<li><p><strong>number_to</strong>: número de WhatsApp do contato, passado como string.</p>\n</li>\n<li><p><strong>number_from</strong>: número de WhatsApp da conta de disparo (a mesma conectada na Rvops), também passado como string.</p>\n</li>\n<li><p><strong>insert_event</strong> (opcional): define se o evento de disparo será registrado na timeline, do tipo boolean.</p>\n</li>\n<li><p><strong>ctaVariable</strong> (opcional): valor da variável do botão CTA (do tipo URL), passado como string.</p>\n</li>\n</ul>\n","urlObject":{"protocol":"https","path":["api","template","send","[idTemplateRvops]"],"host":["server","spread","chat"],"query":[],"variable":[]}},"response":[],"_postman_id":"cea90f31-27a8-4254-8519-68f51af3bc4b"}],"id":"fa3dfc86-32fe-4cb5-acdd-f4963bf8cb9c","_postman_id":"fa3dfc86-32fe-4cb5-acdd-f4963bf8cb9c","description":""},{"name":"Tags","item":[{"name":"create","id":"85983fed-1938-46fd-ac0e-3c8461ff173c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"properties\": {\n\t\t\"tag\": \"Nova etiqueta de contato\"\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/tags/create","description":"<p>Cria uma nova etiqueta na conta.</p>\n","urlObject":{"path":["api","v1","tags","create"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"85983fed-1938-46fd-ac0e-3c8461ff173c"},{"name":"list","id":"43d5c714-ca09-4385-bf0a-24acd905e016","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"<key>","value":""},"isInherited":false},"method":"POST","header":[],"url":"/api/v1/tags","description":"<p>Lista todas as equipes da conta.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Campo</strong></th>\n<th><strong>Valor/tipo</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>id</td>\n<td>Número (id da etiqueta)</td>\n</tr>\n<tr>\n<td>tag</td>\n<td>Texto (nome da etiqueta)</td>\n</tr>\n<tr>\n<td>description</td>\n<td>Texto (descrição da etiqueta)</td>\n</tr>\n<tr>\n<td>qtdLeads</td>\n<td>Número (quantidade de contatos com a etiqueta)</td>\n</tr>\n<tr>\n<td>qtdDeals</td>\n<td>Número (quantidade de negócios com a etiqueta)</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["api","v1","tags"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"43d5c714-ca09-4385-bf0a-24acd905e016"}],"id":"6f91d78e-99b3-4fa9-987e-fd1b20944dc1","_postman_id":"6f91d78e-99b3-4fa9-987e-fd1b20944dc1","description":""}],"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"4fca174f-d8c1-49a3-b6c0-6a4d0f08cb09"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"78218411-5671-4b17-b030-37e2596162e7"}}],"variable":[{"key":"rvops-apikey","value":"","type":"string"},{"key":"domain","value":"","type":"string"}]}