POST /api/v1/deals/{seq}/tags
Adiciona uma etiqueta ao negócio de forma idempotente e retorna a etiqueta.
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 POST \ --url "https://pipefacil-server.matchsales.com.br/api/v1/deals/ $SEQ /tags" \ --header "Authorization: Bearer $PIPEFACIL_API_KEY " \ --header "Content-Type: application/json" \ --data '{ "tagId": "ID_DA_TAG" }' JavaScript const response = await fetch ( `https://pipefacil-server.matchsales.com.br/api/v1/deals/${ process . env . SEQ }/tags` , { method: "POST" , headers: { Authorization: `Bearer ${ process . env . PIPEFACIL_API_KEY }` , "Content-Type" : "application/json" , }, body: JSON . stringify ({ "tagId" : "ID_DA_TAG" }), }); 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( "POST" , f "https://pipefacil-server.matchsales.com.br/api/v1/deals/ { os.environ[ 'SEQ' ] } /tags" , headers = { "Authorization" : f "Bearer { os.environ[ 'PIPEFACIL_API_KEY' ] } " }, json = json.loads( "{ \n \" tagId \" : \" ID_DA_TAG \"\n }" ), ) response.raise_for_status() data = response.json() if response.content else None Parâmetros Nome Local Tipo Obrigatório Descrição seqpathintegerSim —
Corpo da requisição Content-Type: application/json · obrigatório
{ "tagId" : "ID_DA_TAG" } Campo Tipo Obrigatório no objeto Descrição tagIdstringSim —
Esquema OpenAPI { "type" : "object" , "required" : [ "tagId" ], "properties" : { "tagId" : { "type" : "string" } }, "example" : { "tagId" : "ID_DA_TAG" } } Respostas 200 Sucesso Campo Tipo Descrição dataTag— data.idstring— data.namestring— data.colorstring— data.createdAtstringFormato: date-time. data.updatedAtstringFormato: date-time. messagestringAceita null.
Esquema OpenAPI { "type" : "object" , "properties" : { "data" : { "$ref" : "#/components/schemas/Tag" }, "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" ] } 404 Recurso não encontrado ou fora da visibilidade do membro. 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" ] } 
