Skip to main content
GuidesAPI Reference

Create Opportunity

POST 
/crm/opportunities

Create Opportunity

Request​

Query Parameters

    credentialId stringrequired

    The ID of the credential.

Header Parameters

    Authorization stringrequired

    Default value: bearer YOUR_API_KEY

Body

    opportunityName stringrequired

    The name or title of the sales opportunity.

    opportunityStage stringrequired

    The current stage of the sales process that the opportunity is in, such as 'Qualification', 'Proposal', etc.

    closeDate stringrequired

    The projected or actual date on which the opportunity will be or was closed.

    amount string

    The monetary value or revenue potential of the opportunity.

    opportunityDescription string

    A detailed description of the sales opportunity.

    remoteFields json

    An object containing remote fields that are not supported by the common model. The keys are the names of the fields of the corresponding resource in the remote app, and the values can be strings, numbers, arrays or objects.

Responses​

200

Schema

    opportunity

    object

    id string
    remoteId string
    opportunityName string
    opportunityDescription string
    amount integer

    Default value: 0

    opportunityOwner string
    opportunityAccount string
    opportunityStage string
    opportunityStatus string
    lastActivityAt string
    closeDate string
    remoteCreatedAt string
    remoteUpdatedAt string
    remoteDeleted boolean

    Default value: true

    createdAt string
    updatedAt string
Loading...