🏗️ CRM Pipeline

POST /v2/api/external/{apiId}/pipeline/create

PipelineCreate

{"openapi":"3.0.3","info":{"title":"Connect.ai — API Externa","version":"v4.x.x.x"},"tags":[{"name":"🏗️ CRM - Pipeline"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação Connect.ai do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend Connect.ai, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do conta (na coleção Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Connect.ai.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/pipeline/create":{"post":{"tags":["🏗️ CRM - Pipeline"],"summary":"PipelineCreate","operationId":"PipelineCreate","parameters":[{"$ref":"#/components/parameters/ApiId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"responses":{"200":{"description":"Requisição processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Parâmetros inválidos ou faltando."},"401":{"description":"Token ausente, inválido ou sem permissão."}}}}}}

POST /v2/api/external/{apiId}/pipeline/delete/{id}

PipelineDelete

{"openapi":"3.0.3","info":{"title":"Connect.ai — API Externa","version":"v4.x.x.x"},"tags":[{"name":"🏗️ CRM - Pipeline"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação Connect.ai do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend Connect.ai, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do conta (na coleção Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Connect.ai.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/pipeline/delete/{id}":{"post":{"tags":["🏗️ CRM - Pipeline"],"summary":"PipelineDelete","operationId":"PipelineDelete","parameters":[{"$ref":"#/components/parameters/ApiId"},{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Identificador do recurso na rota."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Requisição processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Parâmetros inválidos ou faltando."},"401":{"description":"Token ausente, inválido ou sem permissão."}}}}}}

GET /v2/api/external/{apiId}/pipeline/list

PipelineList

{"openapi":"3.0.3","info":{"title":"Connect.ai — API Externa","version":"v4.x.x.x"},"tags":[{"name":"🏗️ CRM - Pipeline"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação Connect.ai do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend Connect.ai, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do conta (na coleção Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Connect.ai.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/pipeline/list":{"get":{"tags":["🏗️ CRM - Pipeline"],"summary":"PipelineList","operationId":"PipelineList","parameters":[{"$ref":"#/components/parameters/ApiId"},{"name":"page","in":"query","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Requisição processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Parâmetros inválidos ou faltando."},"401":{"description":"Token ausente, inválido ou sem permissão."}}}}}}

GET /v2/api/external/{apiId}/pipeline/show/{id}

PipelineShow

{"openapi":"3.0.3","info":{"title":"Connect.ai — API Externa","version":"v4.x.x.x"},"tags":[{"name":"🏗️ CRM - Pipeline"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação Connect.ai do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend Connect.ai, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do conta (na coleção Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Connect.ai.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/pipeline/show/{id}":{"get":{"tags":["🏗️ CRM - Pipeline"],"summary":"PipelineShow","operationId":"PipelineShow","parameters":[{"$ref":"#/components/parameters/ApiId"},{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Identificador do recurso na rota."}],"responses":{"200":{"description":"Requisição processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Parâmetros inválidos ou faltando."},"401":{"description":"Token ausente, inválido ou sem permissão."}}}}}}

POST /v2/api/external/{apiId}/pipeline/update/{id}

PipelineUpdate

{"openapi":"3.0.3","info":{"title":"Connect.ai — API Externa","version":"v4.x.x.x"},"tags":[{"name":"🏗️ CRM - Pipeline"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação Connect.ai do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend Connect.ai, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do conta (na coleção Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Connect.ai.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/pipeline/update/{id}":{"post":{"tags":["🏗️ CRM - Pipeline"],"summary":"PipelineUpdate","operationId":"PipelineUpdate","parameters":[{"$ref":"#/components/parameters/ApiId"},{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Identificador do recurso na rota."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"}}}}}},"responses":{"200":{"description":"Requisição processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Parâmetros inválidos ou faltando."},"401":{"description":"Token ausente, inválido ou sem permissão."}}}}}}

POST /v2/api/external/{apiId}/stage/create

StageCreate

{"openapi":"3.0.3","info":{"title":"Connect.ai — API Externa","version":"v4.x.x.x"},"tags":[{"name":"🏗️ CRM - Pipeline"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação Connect.ai do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend Connect.ai, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do conta (na coleção Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Connect.ai.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/stage/create":{"post":{"tags":["🏗️ CRM - Pipeline"],"summary":"StageCreate","operationId":"StageCreate","parameters":[{"$ref":"#/components/parameters/ApiId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"pipelineId":{"type":"string"},"order":{"type":"integer"},"color":{"type":"string"}}}}}},"responses":{"200":{"description":"Requisição processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Parâmetros inválidos ou faltando."},"401":{"description":"Token ausente, inválido ou sem permissão."}}}}}}

POST /v2/api/external/{apiId}/stage/delete/{id}

StageDelete

{"openapi":"3.0.3","info":{"title":"Connect.ai — API Externa","version":"v4.x.x.x"},"tags":[{"name":"🏗️ CRM - Pipeline"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação Connect.ai do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend Connect.ai, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do conta (na coleção Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Connect.ai.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/stage/delete/{id}":{"post":{"tags":["🏗️ CRM - Pipeline"],"summary":"StageDelete","operationId":"StageDelete","parameters":[{"$ref":"#/components/parameters/ApiId"},{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Identificador do recurso na rota."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Requisição processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Parâmetros inválidos ou faltando."},"401":{"description":"Token ausente, inválido ou sem permissão."}}}}}}

GET /v2/api/external/{apiId}/stage/list

StageList

{"openapi":"3.0.3","info":{"title":"Connect.ai — API Externa","version":"v4.x.x.x"},"tags":[{"name":"🏗️ CRM - Pipeline"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação Connect.ai do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend Connect.ai, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do conta (na coleção Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Connect.ai.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/stage/list":{"get":{"tags":["🏗️ CRM - Pipeline"],"summary":"StageList","operationId":"StageList","parameters":[{"$ref":"#/components/parameters/ApiId"},{"name":"page","in":"query","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer"}},{"name":"pipelineId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Requisição processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Parâmetros inválidos ou faltando."},"401":{"description":"Token ausente, inválido ou sem permissão."}}}}}}

GET /v2/api/external/{apiId}/stage/show/{id}

StageShow

{"openapi":"3.0.3","info":{"title":"Connect.ai — API Externa","version":"v4.x.x.x"},"tags":[{"name":"🏗️ CRM - Pipeline"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação Connect.ai do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend Connect.ai, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do conta (na coleção Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Connect.ai.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/stage/show/{id}":{"get":{"tags":["🏗️ CRM - Pipeline"],"summary":"StageShow","operationId":"StageShow","parameters":[{"$ref":"#/components/parameters/ApiId"},{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Identificador do recurso na rota."}],"responses":{"200":{"description":"Requisição processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Parâmetros inválidos ou faltando."},"401":{"description":"Token ausente, inválido ou sem permissão."}}}}}}

POST /v2/api/external/{apiId}/stage/update/{id}

StageUpdate

{"openapi":"3.0.3","info":{"title":"Connect.ai — API Externa","version":"v4.x.x.x"},"tags":[{"name":"🏗️ CRM - Pipeline"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação Connect.ai do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend Connect.ai, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do conta (na coleção Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Connect.ai.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/stage/update/{id}":{"post":{"tags":["🏗️ CRM - Pipeline"],"summary":"StageUpdate","operationId":"StageUpdate","parameters":[{"$ref":"#/components/parameters/ApiId"},{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Identificador do recurso na rota."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"}}}}}},"responses":{"200":{"description":"Requisição processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Parâmetros inválidos ou faltando."},"401":{"description":"Token ausente, inválido ou sem permissão."}}}}}}

Este artigo foi útil?