API - Chamada API para criar/atualizar Oportunidade no CRM

Criar Nova Oportunidade

POST /crmopportunity?id=XX&i=instancia

id = ID do Funil

i = nome_da_instancia (exemplo: suaempresa)

Chamada completa: https://sprinthub-api-master.sprinthub.app/crmopportunity?id=xx&i=instancia

<Criar uma Nova Oportunidade>

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>
apitoken	XXXXXXXXX

Body

Name	Type	Description
title	string	Título da Oportnidade
value	number	Valor da Oportunidade (somente n.)
crm_column	number	ID da Coluna
lead_id	number	ID do Lead
sequence	number	ID da Sequência
status	string	open/gain/lost
expectedCloseDate	date	Formato ISO: 2024-03-21T21:27:00.000Z
user	number	ID do usuário responsável
"fields": { "Campo1": "Valor1", "Campo2": "Valor2", "Campo3": "Valor3" }	objeto json	Os campos customizados de CRM precisam estar dentro de um Objeto Json com o nome "fields"

Response

Codigos ao lado

200

```json
{
    "id": 4534,
    "title": "Test Titulo",
    "value": 1,
    "crm_column": 159,
    "lead_id": 8473,
    "sequence": 3,
    "status": "open",
    "loss_reason": null,
    "gain_reason": null,
    "expectedCloseDate": null,
    "sale_channel": null,
    "campaign": null,
    "user": 156,
    "last_column_change": null,
    "last_status_change": null,
    "gain_date": null,
    "lost_date": null,
    "reopen_date": null,
    "await_column_approved": null,
    "await_column_approved_user": null,
    "reject_appro": null,
    "reject_appro_desc": null,
    "createDate": "2024-03-19T21:14:35.000Z",
    "updateDate": "2024-03-19T21:14:35.000Z",
    "sprint_permission": "all",
    "sprint_permission_user": null,
    "sprint_permission_department": null,
    "sprint_permission_users": [],
    "sprint_permission_users_select": [],
    "sprint_permission_departments": [],
    "sprint_permission_departments_select": [],
    "dataLead": {
        "_id": "645bab79d618593673238ccb",
        "id": 8473,
        "address": null,
        "canal_de_aquisicao": null,
        "channelRestrictions": {
            "instagram": {
                "mainChannel": false,
                "disabled": false,
                "frequencyValue": null,
                "frequencyUnits": "DAY"
            },
            "whatsapp": {
                "mainChannel": false,
                "disabled": false,
                "frequencyValue": null,
                "frequencyUnits": "DAY"
            },
            "email": {
                "mainChannel": true,
                "disabled": false,
                "frequencyValue": 5,
                "frequencyUnits": "DAY"
            },
            "messenger": {
                "mainChannel": false,
                "disabled": false,
                "frequencyValue": null,
                "frequencyUnits": "DAY"
            }
        },
        "city": "São Paulo",
        "company": 2582,
        "country": "Brazil",
        "createDate": "2023-05-10T14:34:33.187Z",
        "createdBy": null,
        "createdByName": "System",
        "email": "[e-mail]",
        "firstname": "Teste",
        "instancedomain": "teste",
        "ips": [
            "187.34.47.xx",
            "177.76.52.xx",
            "189.0.84.xx",
            "179.193.100.xx",
            "177.62.4.xx",
            "187.89.87.xx"
        ],
        "lastActive": "2024-03-19T21:14:35.693Z",
        "lastname": "Silva",
        "link_instancia": null,
        "mobile": null,
        "owner": null,
        "phone": null,
        "photoUrl": null,
        "points": 30,
        "preferred_locale": "pt-BR",
        "senha_inicial": "teste123",
        "stage": null,
        "state": null,
        "timezone": "America/Sao_Paulo",
        "updatedBy": null,
        "updatedByName": null,
        "updatedDate": null,
        "utmTags": [],
        "whatsapp": "+5511xxxxxxx",
        "zipcode": null,
        "cargo": null,
        "departamento": null,
        "departmentAccess": [],
        "ignoreSubDepartments": false,
        "instance_active": "false",
        "lead_online": "false",
        "partner_instance": null,
        "userAccess": [],
        "createdByType": null
    },
    "dataCompany": {
        "_id": "645bab8axxxxd618565",
        "id": 2582,
        "cnpj": null,
        "companyaddress": null,
        "companyannualrevenue": null,
        "companycity": null,
        "companycountry": null,
        "companyemail": null,
        "companyindustry": null,
        "companyname": "Microsoft Inc",
        "companynemployees": null,
        "companyphone": null,
        "companystate": null,
        "companyzipcode": null,
        "createDate": "2023-05-10T14:34:50.537Z",
        "createdBy": null,
        "createdByName": "System",
        "dores": null,
        "owner": null,
        "photoUrl": null,
        "points": 0,
        "qtdeclientes": null,
        "updatedBy": null,
        "updatedByName": null,
        "updatedDate": null
    },
    "dataCompanyExtra": [
        {
            "id": 2582,
            "cnpj": null,
            "companyaddress": null,
            "companyannualrevenue": null,
            "companycity": null,
            "companycountry": null,
            "companyemail": null,
            "companyindustry": null,
            "companyname": "Microsoft Inc",
            "companynemployees": null,
            "companyphone": null,
            "companystate": null,
            "companyzipcode": null,
            "createDate": "2023-05-10T14:34:50.537Z",
            "createdBy": null,
            "createdByName": "System",
            "dores": null,
            "owner": null,
            "photoUrl": null,
            "points": 0,
            "qtdeclientes": null,
            "updatedBy": null,
            "updatedByName": null,
            "updatedDate": null
        }
    ],
    "fields": {
        "Campo com Espaço": "9969887dddXXXXX"
    },
    "files": [],
    "filesData": []
}
```

400

```json
{
    "msg": "Mensagem de Erro."
}
```

---

Atualizar uma Oportunidade

PUT /crmopportunity/XXX?id=XX&i=instancia

XXX = ID da Oportunidade (number)

id = ID do Funil

i = nome_da_instancia (exemplo: suaempresa)

Chamada completa: https://sprinthub-api-master.sprinthub.app/crmopportunity/XXX?id=xx&i=instancia

<Atualizar uma Oportunidade>

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>
apitoken	XXXXXXXXX

Body

Name	Type	Description
title	string	Título da Oportnidade
value	number	Valor da Oportunidade (somente n.)
crm_column	number	ID da Coluna
lead_id	number	ID do Lead
sequence	number	ID da Sequência
status	string	open/gain/lost
expectedCloseDate	date	Formato ISO: 2024-03-21T21:27:00.000Z
user	number	ID do usuário responsável
"fields": { "Campo1": "Valor1", "Campo2": "Valor2", "Campo3": "Valor3" }	objeto json	Os campos customizados de CRM precisam estar dentro de um Objeto Json com o nome "fields"

Response

200

```json
{
    "msg": "A oportunidade foi atualizada.",
    "data": {
        "id": XXX,
        "outros campos": ....
}
```

400

{
  "error": "Invalid request"
}

Exemplos usando Postman

Criar Oportunidade

Atualizar uma Oportunidade existente: