Negócios com campos esperando revisão

GET

/v1/review/suggestions

curl --request GET \
  --url https://developers.nexo.winningsales.com.br/v1/review/suggestions \
  --header 'Authorization: Bearer <token>'

Um cartão por negócio com cada sugestão de campo do CRM em aberto: o que o Nexo leu, o que o CRM tem e a situação. Nada é escrito no CRM por esta leitura. O vendedor vê os próprios negócios; admin e líder de vendas veem todos e podem filtrar por dono.

Authorizations

• bearer

Parameters

Query Parameters

ownerId

Show only the deals of this owner; managers only

string format: uuid

Show only the deals of this owner; managers only

Responses

200

Negócios com sugestões em aberto

Media typeapplication/json

object

deals

required

Deals with open suggestions, the ones with more pending first

Array<object>

object

dealId

required

Deal id

string format: uuid

externalId

required

Id of the deal in the CRM

string

name

required

Deal name

string

ownerId

required

Owner id

string format: uuid

nullable

ownerName

required

Owner name

string

nullable

amountInCents

required

Deal amount in cents

number

nullable

currency

required

Currency code

string

pending

required

Suggestions waiting for a decision, including the ones the CRM refused

integer

approved

required

Approved and not written yet

integer

total

required

Every open suggestion of the deal

integer

fields

required

One row per suggestion

Array<object>

object

id

required

Suggestion id

string format: uuid

concept

required

Concept id

string

label

required

Concept label, pt-BR

string

status

required

Where the suggestion is in its life

string

Allowed values: pending approved rejected writing written failed invalid superseded awaiting_field held reverting reverted

kind

required

How to edit it: text, number, money, date, datetime, bool, enum, stage, contact, or meeting_note for the note of a meeting

string

currentValue

required

One of:

string

string

number

number

boolean

boolean

unknown

Value in Nexo now

currentLabel

required

Stage name when the kind is stage

string

nullable

proposedValue

required

One of:

string

string

number

number

boolean

boolean

unknown

Value proposed, or the edited one when there is one

proposedLabel

required

Stage name when the kind is stage

string

nullable

stage

required

True for a stage suggestion

boolean

failed

required

True when the CRM refused the last write

boolean

changed

required

True when the CRM value changed after the reading

boolean

contact

required

The contact Nexo proposes to create; only for kind contact

object

firstName

required

First name

string

lastName

required

Last name

string

nullable

jobTitle

required

Job title said in the conversation

string

nullable

buyingRole

required

Buying role, as the CRM option value, when the field is mapped

string

nullable

accountName

required

Company the contact is linked to, besides the deal

string

nullable

edited

required

True when the person edited the name or job title

boolean

pending

required

Pending suggestions across the listed deals

integer

dealsPending

required

Deals with at least one pending suggestion

integer

Example

{
  "deals": [
    {
      "fields": [
        {
          "status": "pending"
        }
      ]
    }
  ]
}

400

Filtro inválido

Media typeapplication/json

object

type

required

Stable machine-readable error code (e.g. identity.email_already_in_use)

string

title

required

Error class name

string

status

required

HTTP status code

integer

detail

required

Human-readable message, safe to display to end users

string

requestId

required

Correlation id — send it to support to locate the full trail

string

nullable

meta

Structured details safe for the frontend (field errors, ids)

object

key

additional properties

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "requestId": "example",
  "meta": {
    "additionalProperty": "example"
  }
}

401

Token ausente, inválido, expirado ou revogado

Media typeapplication/json

object

type

required

Stable machine-readable error code (e.g. identity.email_already_in_use)

string

title

required

Error class name

string

status

required

HTTP status code

integer

detail

required

Human-readable message, safe to display to end users

string

requestId

required

Correlation id — send it to support to locate the full trail

string

nullable

meta

Structured details safe for the frontend (field errors, ids)

object

key

additional properties

Example

{
  "type": "public_api.invalid_credential",
  "title": "InvalidCredentialError",
  "status": 401,
  "detail": "Token de acesso inválido, expirado ou revogado. Crie um novo token de acesso no Nexo.",
  "requestId": "019fcae7-3e54-755a-8458-bdb605b324bb"
}

403

Papel, escopo do token ou plano não permitem a operação

Media typeapplication/json

object

type

required

Stable machine-readable error code (e.g. identity.email_already_in_use)

string

title

required

Error class name

string

status

required

HTTP status code

integer

detail

required

Human-readable message, safe to display to end users

string

requestId

required

Correlation id — send it to support to locate the full trail

string

nullable

meta

Structured details safe for the frontend (field errors, ids)

object

key

additional properties

Example

{
  "type": "public_api.insufficient_scope",
  "title": "InsufficientScopeError",
  "status": 403,
  "detail": "Este token não tem o escopo conversations:read, exigido por esta operação. Gere um token com esse escopo.",
  "requestId": "019fcae7-3e54-755a-8458-bdb605b324bb",
  "meta": {
    "operation": "conversations.reading",
    "scope": "conversations:read"
  }
}

429

Limite de chamadas da empresa ou do token atingido

Media typeapplication/json

object

type

required

Stable machine-readable error code (e.g. identity.email_already_in_use)

string

title

required

Error class name

string

status

required

HTTP status code

integer

detail

required

Human-readable message, safe to display to end users

string

requestId

required

Correlation id — send it to support to locate the full trail

string

nullable

meta

Structured details safe for the frontend (field errors, ids)

object

key

additional properties

Example

{
  "type": "public_api.rate_limited",
  "title": "PublicRateLimitedError",
  "status": 429,
  "detail": "Muitas chamadas em pouco tempo. Tente de novo em 12 segundos.",
  "requestId": "019fcae7-3e54-755a-8458-bdb605b324bb",
  "meta": {
    "class": "content",
    "limitedBy": "company",
    "limit": 120,
    "windowSeconds": 60,
    "retryAfterSeconds": 12
  }
}