API - API call to create/update Opportunity in the CRM

Create New Opportunity

POST /crmopportunity?id=XX&i=instance

id = Funnel ID

i = instance_name (example: yourcompany)

Full call: https://sprinthub-api-master.sprinthub.app/crmopportunity?id=xx&i=instance

Headers

Name

Value

Content-Type

application/json

Authorization

Bearer <token>

apitoken

XXXXXXXXX

Body

Name

Type

Description

title

string

Opportunity Title

value

number

Opportunity Value (numbers only)

crm_column

number

Column ID

lead_id

number

Lead ID

sequence

number

Sequence ID

status

string

open/gain/lost

expectedCloseDate

date

ISO Format: 2024-03-21T21:27:00.000Z

user

number

Responsible user ID

"fields": {

"Field1": "Value1",

"Field2": "Value2",

"Field3": "Value3"

}

json object

CRM custom fields need to be inside a JSON Object named "fields"

Response

```json
{
    "id": 4534,
    "title": "Test Title",
    "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": "[email protected]",
        "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": {
        "Field with Space": "9969887dddXXXXX"
    },
    "files": [],
    "filesData": []
}
```

Update an Opportunity

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

XXX = Opportunity ID (number)

id = Funnel ID

i = instance_name (example: yourcompany)

Full call: https://sprinthub-api-master.sprinthub.app/crmopportunity/XXX?id=xx&i=instance

Headers

Name

Value

Content-Type

application/json

Authorization

Bearer <token>

apitoken

XXXXXXXXX

Body

Name

Type

Description

title

string

Opportunity Title

value

number

Opportunity Value (numbers only)

crm_column

number

Column ID

lead_id

number

Lead ID

sequence

number

Sequence ID

status

string

open/gain/lost

expectedCloseDate

date

ISO Format: 2024-03-21T21:27:00.000Z

user

number

Responsible user ID

"fields": {

"Field1": "Value1",

"Field2": "Value2",

"Field3": "Value3"

}

json object

CRM custom fields need to be inside a JSON Object named "fields"

Response

```json
{
    "msg": "The opportunity has been updated.",
    "data": {
        "id": XXX,
        "other fields": ....
}
```

Examples using Postman

Create Opportunity

Update an existing Opportunity:

PreviousAPI - How to register the API key NextAPI - API call to List Opportunities of a Lead

Last updated 1 year ago

Was this helpful?

```json { "id": 4534, "title": "Test Title", "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": "[email protected]", "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": { "Field with Space": "9969887dddXXXXX" }, "files": [], "filesData": [] } ```

hashtagCreate New Opportunity

hashtagUpdate an Opportunity

hashtagExamples using Postman

hashtagCreate Opportunity

hashtag

hashtag

hashtagUpdate an existing Opportunity:

Create New Opportunity

Update an Opportunity

Examples using Postman

Create Opportunity

Update an existing Opportunity: