PUT /api/v1/pipelines/loss-reasons
Substitui o catálogo de motivos de perda do workspace. Aceita até 50 motivos, não vazios e com até 255 caracteres cada. Retorna a lista normalizada e salva. Exige settings.pipelines.
Exemplos A URL usa o servidor de produção. Defina PIPEFACIL_API_KEY e as variáveis de caminho (como SEQ ou ID) com os identificadores reais. Ajuste o corpo antes de executar: requisições de escrita alteram dados do workspace.
cURL curl --request PUT \ --url "https://pipefacil-server.matchsales.com.br/api/v1/pipelines/loss-reasons" \ --header "Authorization: Bearer $PIPEFACIL_API_KEY " \ --header "Content-Type: application/json" \ --data '{ "lossReasons": [ "Sem orçamento", "Sem aderência" ] }' JavaScript const response = await fetch ( `https://pipefacil-server.matchsales.com.br/api/v1/pipelines/loss-reasons` , { method: "PUT" , headers: { Authorization: `Bearer ${ process . env . PIPEFACIL_API_KEY }` , "Content-Type" : "application/json" , }, body: JSON . stringify ({ "lossReasons" : [ "Sem orçamento" , "Sem aderência" ] }), }); if ( ! response.ok) throw new Error ( `HTTP ${ response . status }: ${ await response . text () }` ); const text = await response. text (); const data = text ? JSON . parse (text) : null ; Python import os import json import requests response = requests.request( "PUT" , f "https://pipefacil-server.matchsales.com.br/api/v1/pipelines/loss-reasons" , headers = { "Authorization" : f "Bearer { os.environ[ 'PIPEFACIL_API_KEY' ] } " }, json = json.loads( "{ \n \" lossReasons \" : [ \n \" Sem orçamento \" , \n \" Sem aderência \"\n ] \n }" ), ) response.raise_for_status() data = response.json() if response.content else None Corpo da requisição Content-Type: application/json · obrigatório
{ "lossReasons" : [ "Sem orçamento" , "Sem aderência" ] } Campo Tipo Obrigatório no objeto Descrição lossReasonsarraySim —
Esquema OpenAPI { "type" : "object" , "required" : [ "lossReasons" ], "properties" : { "lossReasons" : { "type" : "array" , "maxItems" : 50 , "items" : { "type" : "string" , "minLength" : 1 , "maxLength" : 255 } } } } Respostas 200 Sucesso Campo Tipo Descrição dataarray— messagestringAceita null.
Esquema OpenAPI { "type" : "object" , "properties" : { "data" : { "type" : "array" , "items" : { "type" : "string" } }, "message" : { "type" : "string" , "nullable" : true } } } 400 Falha de validação dos campos; `fieldErrors` contém os erros. Campo Tipo Descrição errorstring— codestringValores: BAD_REQUEST, VALIDATION_ERROR, UNAUTHORIZED, FORBIDDEN, FEATURE_DISABLED, NOT_FOUND, CONFLICT, QUOTA_EXCEEDED, UNPROCESSABLE_ENTITY, INTERNAL_ERROR, SERVICE_UNAVAILABLE. requestIdstring— detailsstringAceita null. fieldErrorsarrayAceita null. fieldErrors[].fieldstring— fieldErrors[].messagestring—
Esquema OpenAPI { "type" : "object" , "description" : "Formato padrão de erro. `details` e `fieldErrors` são omitidos quando ausentes." , "properties" : { "error" : { "type" : "string" }, "code" : { "type" : "string" , "enum" : [ "BAD_REQUEST" , "VALIDATION_ERROR" , "UNAUTHORIZED" , "FORBIDDEN" , "FEATURE_DISABLED" , "NOT_FOUND" , "CONFLICT" , "QUOTA_EXCEEDED" , "UNPROCESSABLE_ENTITY" , "INTERNAL_ERROR" , "SERVICE_UNAVAILABLE" ] }, "requestId" : { "type" : "string" }, "details" : { "type" : "string" , "nullable" : true }, "fieldErrors" : { "type" : "array" , "nullable" : true , "items" : { "type" : "object" , "properties" : { "field" : { "type" : "string" }, "message" : { "type" : "string" } } } } }, "required" : [ "error" , "code" , "requestId" ] } 401 Chave ausente, malformada, desconhecida, revogada ou expirada, ou membro emissor inativo. Campo Tipo Descrição errorstring— codestringValores: BAD_REQUEST, VALIDATION_ERROR, UNAUTHORIZED, FORBIDDEN, FEATURE_DISABLED, NOT_FOUND, CONFLICT, QUOTA_EXCEEDED, UNPROCESSABLE_ENTITY, INTERNAL_ERROR, SERVICE_UNAVAILABLE. requestIdstring— detailsstringAceita null. fieldErrorsarrayAceita null. fieldErrors[].fieldstring— fieldErrors[].messagestring—
Esquema OpenAPI { "type" : "object" , "description" : "Formato padrão de erro. `details` e `fieldErrors` são omitidos quando ausentes." , "properties" : { "error" : { "type" : "string" }, "code" : { "type" : "string" , "enum" : [ "BAD_REQUEST" , "VALIDATION_ERROR" , "UNAUTHORIZED" , "FORBIDDEN" , "FEATURE_DISABLED" , "NOT_FOUND" , "CONFLICT" , "QUOTA_EXCEEDED" , "UNPROCESSABLE_ENTITY" , "INTERNAL_ERROR" , "SERVICE_UNAVAILABLE" ] }, "requestId" : { "type" : "string" }, "details" : { "type" : "string" , "nullable" : true }, "fieldErrors" : { "type" : "array" , "nullable" : true , "items" : { "type" : "object" , "properties" : { "field" : { "type" : "string" }, "message" : { "type" : "string" } } } } }, "required" : [ "error" , "code" , "requestId" ] } 403 Autenticado, mas sem acesso: falta de permissão (`FORBIDDEN`), recurso desligado no workspace (`FEATURE_DISABLED`) ou tentativa de acessar uma agenda não permitida. Campo Tipo Descrição errorstring— codestringValores: BAD_REQUEST, VALIDATION_ERROR, UNAUTHORIZED, FORBIDDEN, FEATURE_DISABLED, NOT_FOUND, CONFLICT, QUOTA_EXCEEDED, UNPROCESSABLE_ENTITY, INTERNAL_ERROR, SERVICE_UNAVAILABLE. requestIdstring— detailsstringAceita null. fieldErrorsarrayAceita null. fieldErrors[].fieldstring— fieldErrors[].messagestring—
Esquema OpenAPI { "type" : "object" , "description" : "Formato padrão de erro. `details` e `fieldErrors` são omitidos quando ausentes." , "properties" : { "error" : { "type" : "string" }, "code" : { "type" : "string" , "enum" : [ "BAD_REQUEST" , "VALIDATION_ERROR" , "UNAUTHORIZED" , "FORBIDDEN" , "FEATURE_DISABLED" , "NOT_FOUND" , "CONFLICT" , "QUOTA_EXCEEDED" , "UNPROCESSABLE_ENTITY" , "INTERNAL_ERROR" , "SERVICE_UNAVAILABLE" ] }, "requestId" : { "type" : "string" }, "details" : { "type" : "string" , "nullable" : true }, "fieldErrors" : { "type" : "array" , "nullable" : true , "items" : { "type" : "object" , "properties" : { "field" : { "type" : "string" }, "message" : { "type" : "string" } } } } }, "required" : [ "error" , "code" , "requestId" ] } 429 Limite de requisições excedido por workspace ou IP. Campo Tipo Descrição errorstring— codestringValores: BAD_REQUEST, VALIDATION_ERROR, UNAUTHORIZED, FORBIDDEN, FEATURE_DISABLED, NOT_FOUND, CONFLICT, QUOTA_EXCEEDED, UNPROCESSABLE_ENTITY, INTERNAL_ERROR, SERVICE_UNAVAILABLE. requestIdstring— detailsstringAceita null. fieldErrorsarrayAceita null. fieldErrors[].fieldstring— fieldErrors[].messagestring—
Esquema OpenAPI { "type" : "object" , "description" : "Formato padrão de erro. `details` e `fieldErrors` são omitidos quando ausentes." , "properties" : { "error" : { "type" : "string" }, "code" : { "type" : "string" , "enum" : [ "BAD_REQUEST" , "VALIDATION_ERROR" , "UNAUTHORIZED" , "FORBIDDEN" , "FEATURE_DISABLED" , "NOT_FOUND" , "CONFLICT" , "QUOTA_EXCEEDED" , "UNPROCESSABLE_ENTITY" , "INTERNAL_ERROR" , "SERVICE_UNAVAILABLE" ] }, "requestId" : { "type" : "string" }, "details" : { "type" : "string" , "nullable" : true }, "fieldErrors" : { "type" : "array" , "nullable" : true , "items" : { "type" : "object" , "properties" : { "field" : { "type" : "string" }, "message" : { "type" : "string" } } } } }, "required" : [ "error" , "code" , "requestId" ] } 
