Mover negocio de etapa
POST
https://api.bydomu.com/v1/deals/{id}/moveEsta referência é gerada a partir do código da API, por isso as descrições estão em espanhol. Nomes, parâmetros e exemplos são iguais em qualquer idioma.
Mueve el negocio a otra etapa. Al caer en una etapa de ganado o perdido se disparan sus efectos (comisiones, eventos deal.won / deal.lost). Los movimientos de la API quedan marcados como automáticos en el informe de tiempo por etapa.
Permissão
deals:writeChaves
Só secreta (de um servidor)
Cabeçalhos
X-API-KeystringobrigatórioSua chave secreta.
Idempotency-KeystringClave única de la operación (8-128 caracteres de
[a-zA-Z0-9._:-]). Un reintento con la misma clave y el mismo cuerpo devuelve la respuesta original sin repetir la operación. Vive 24 horas. · 8–128 charsParâmetros de rota
idstringobrigatórioID del negocio
Corpo (JSON)
stageIdstringobrigatóriopipelineIdstringobrigatóriostageOrderintegerobrigatório≥ 0
lostReasonstring≤ 1000 chars
lostReasonCategorystringPRECIOCOMPETENCIAFINANCIAMIENTOUBICACIONTIMINGCONDICIONSIN_RESPUESTAOTROcommissionConfigIdstringdealValuenumber≥ 0 · nullable
commissionGrossAmountnumber≥ 0 · nullable
Respostas
200Negocio en su nueva etapa
400Datos inválidos: el cuerpo o la query no cumplen el esquema, o `Idempotency-Key` está mal formada.
401
UNAUTHORIZED · Clave faltante, inválida, desactivada o vencida.402
PAYMENT_REQUIRED · Cuenta en modo solo lectura: se rechaza toda mutación.403
FORBIDDEN · La clave no puede usar esta operación: falta el scope, es una secreta en el navegador, el nivel de la cuenta no la permite, está suspendida o se alcanzó un tope del plan.404
NOT_FOUND · El recurso no existe en la organización.409
DUPLICATE · Choca con un dato existente o con el estado actual, o la `Idempotency-Key` ya se usó con otro cuerpo o sigue en curso.429
RATE_LIMITED · Límite de peticiones excedido: el de la clave (`RATE_LIMITED`), el de escrituras de la organización (`TENANT_RATE_LIMITED`) o bloqueo temporal de la IP por claves inválidas.500
INTERNAL_ERROR · Error interno del servidor.