/opportunities/{id}

from merge import Merge
from merge.resources.crm import PatchedOpportunityRequest
client = Merge(
    account_token="YOUR_ACCOUNT_TOKEN",
    api_key="YOUR_API_KEY",
)
client.crm.opportunities.partial_update(
    id="id",
    model=PatchedOpportunityRequest(),
)

{
  "model": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "remote_id": "19202938",
    "created_at": "2021-09-15T00:00:00Z",
    "modified_at": "2021-10-16T00:00:00Z",
    "name": "Needs Integrations",
    "description": "Needs a Unified API for Integrations!",
    "amount": 100000,
    "owner": "0358cbc6-2040-430a-848e-aafacbadf3aa",
    "account": "0958cbc6-6040-430a-848e-aafacbadf4ae",
    "stage": "1968cbc6-6040-430a-848e-aafacbadf4ad",
    "status": "WON",
    "last_activity_at": "2022-02-10T00:00:00Z",
    "close_date": "2022-02-10T00:00:00Z",
    "remote_created_at": "2021-11-10T00:00:00Z",
    "remote_was_deleted": true,
    "field_mappings": {
      "organization_defined_targets": {
        "custom_key": "custom_value"
      },
      "linked_account_defined_targets": {
        "custom_key": "custom_value"
      }
    },
    "remote_data": [
      {
        "path": "/opportunities"
      }
    ],
    "remote_fields": [
      {
        "remote_field_class": {
          "id": "string",
          "display_name": "string",
          "remote_key_name": "string",
          "description": "string",
          "is_custom": true,
          "is_common_model_field": true,
          "is_required": true,
          "field_type": "string",
          "field_format": "string",
          "field_choices": [
            "string"
          ],
          "item_schema": {
            "item_type": "string",
            "item_format": "string",
            "item_choices": [
              "string"
            ]
          }
        },
        "value": "string"
      }
    ]
  },
  "warnings": [
    {
      "title": "Unrecognized Field",
      "detail": "An unrecognized field, age, was passed in with request data.",
      "problem_type": "UNRECOGNIZED_FIELD",
      "source": {
        "pointer": "/age"
      },
      "block_merge_link": true
    }
  ],
  "errors": [
    {
      "title": "Missing Required Field",
      "detail": "custom_fields is a required field on model.",
      "problem_type": "MISSING_REQUIRED_FIELD",
      "source": {
        "pointer": "/model/custom_fields"
      },
      "block_merge_link": true
    }
  ],
  "logs": [
    {
      "log_id": "99433219-8017-4acd-bb3c-ceb23d663832",
      "dashboard_view": "https://app.merge.dev/logs/99433219-8017-4acd-bb3c-ceb23d663832",
      "log_summary": {
        "url": "www.exampleintegration.com/api/v1/exampleapi",
        "method": "POST",
        "status_code": 200
      }
    }
  ]
}

Updates an Opportunity object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Query parameters

is_debug_modebooleanOptional

Whether to include debug fields (such as log file links) in the response.

run_asyncbooleanOptional

Whether or not third-party updates should be run asynchronously.

Request

This endpoint expects an object.

modelobjectRequired

Description

The Opportunity object is used to represent a deal opportunity in a CRM system.

Usage Example

TODO

Response

modelobject

Description

The Opportunity object is used to represent a deal opportunity in a CRM system.

Usage Example

TODO

warningslist of objects

errorslist of objects

logslist of objects or null

Supported PATCH model parameters

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The opportunity's name.

descriptionstring or nullOptional

The opportunity's description.

amountinteger or nullOptional-2147483648-2147483647

The opportunity's amount.

ownerstring or nullOptionalformat: "uuid"

The opportunity's owner.

accountstring or nullOptionalformat: "uuid"

The account of the opportunity.

stagestring or nullOptionalformat: "uuid"

The stage of the opportunity.

statusenum or nullOptional

The opportunity’s status.

OPEN - OPEN
WON - WON
LOST - LOST

Allowed values:

close_datedatetime or nullOptional

When the opportunity was closed.

Supported PATCH model parameters

namestring or nullOptional

The opportunity's name.

descriptionstring or nullOptional

The opportunity's description.

amountinteger or nullOptional-2147483648-2147483647

The opportunity's amount.

ownerstring or nullOptionalformat: "uuid"

The opportunity's owner.

accountstring or nullOptionalformat: "uuid"

The account of the opportunity.

stagestring or nullOptionalformat: "uuid"

The stage of the opportunity.

statusenum or nullOptional

The opportunity’s status.

OPEN - OPEN
WON - WON
LOST - LOST

Allowed values:

last_activity_atdatetime or nullOptional

When the opportunity's last activity occurred.

close_datedatetime or nullOptional

When the opportunity was closed.

remote_created_atdatetime or nullOptional

When the third party's opportunity was created.

remote_fieldslist of objectsOptionalRead-only

Supported PATCH model parameters

namestring or nullOptional

The opportunity's name.

amountinteger or nullOptional-2147483648-2147483647

The opportunity's amount.

ownerstring or nullOptionalformat: "uuid"

The opportunity's owner.

accountstring or nullOptionalformat: "uuid"

The account of the opportunity.

stagestring or nullOptionalformat: "uuid"

The stage of the opportunity.

statusenum or nullOptional

The opportunity’s status.

OPEN - OPEN
WON - WON
LOST - LOST

Allowed values:

last_activity_atdatetime or nullOptional

When the opportunity's last activity occurred.

close_datedatetime or nullOptional

When the opportunity was closed.

remote_created_atdatetime or nullOptional

When the third party's opportunity was created.

remote_fieldslist of objectsOptionalRead-only

Supported PATCH model parameters

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The opportunity's name.

amountinteger or nullOptional-2147483648-2147483647

The opportunity's amount.

ownerstring or nullOptionalformat: "uuid"

The opportunity's owner.

accountstring or nullOptionalformat: "uuid"

The account of the opportunity.

stagestring or nullOptionalformat: "uuid"

The stage of the opportunity.

statusenum or nullOptional

The opportunity’s status.

OPEN - OPEN
WON - WON
LOST - LOST

Allowed values:

last_activity_atdatetime or nullOptional

When the opportunity's last activity occurred.

close_datedatetime or nullOptional

When the opportunity was closed.

remote_created_atdatetime or nullOptional

When the third party's opportunity was created.

Supported PATCH model parameters

namestring or nullOptional

The opportunity's name.

descriptionstring or nullOptional

The opportunity's description.

amountinteger or nullOptional-2147483648-2147483647

The opportunity's amount.

ownerstring or nullOptionalformat: "uuid"

The opportunity's owner.

accountstring or nullOptionalformat: "uuid"

The account of the opportunity.

stagestring or nullOptionalformat: "uuid"

The stage of the opportunity.

statusenum or nullOptional

The opportunity’s status.

OPEN - OPEN
WON - WON
LOST - LOST

Allowed values:

last_activity_atdatetime or nullOptional

When the opportunity's last activity occurred.

close_datedatetime or nullOptional

When the opportunity was closed.

remote_created_atdatetime or nullOptional

When the third party's opportunity was created.

remote_fieldslist of objectsOptionalRead-only

Supported PATCH model parameters

namestring or nullOptional

The opportunity's name.

descriptionstring or nullOptional

The opportunity's description.

amountinteger or nullOptional-2147483648-2147483647

The opportunity's amount.

ownerstring or nullOptionalformat: "uuid"

The opportunity's owner.

accountstring or nullOptionalformat: "uuid"

The account of the opportunity.

stagestring or nullOptionalformat: "uuid"

The stage of the opportunity.

last_activity_atdatetime or nullOptional

When the opportunity's last activity occurred.

close_datedatetime or nullOptional

When the opportunity was closed.

remote_created_atdatetime or nullOptional

When the third party's opportunity was created.

Supported PATCH model parameters

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The opportunity's name.

descriptionstring or nullOptional

The opportunity's description.

amountinteger or nullOptional-2147483648-2147483647

The opportunity's amount.

ownerstring or nullOptionalformat: "uuid"

The opportunity's owner.

accountstring or nullOptionalformat: "uuid"

The account of the opportunity.

stagestring or nullOptionalformat: "uuid"

The stage of the opportunity.

statusenum or nullOptional

The opportunity’s status.

OPEN - OPEN
WON - WON
LOST - LOST

Allowed values:

close_datedatetime or nullOptional

When the opportunity was closed.

Supported PATCH model parameters

namestring or nullOptional

The opportunity's name.

descriptionstring or nullOptional

The opportunity's description.

amountinteger or nullOptional-2147483648-2147483647

The opportunity's amount.

ownerstring or nullOptionalformat: "uuid"

The opportunity's owner.

accountstring or nullOptionalformat: "uuid"

The account of the opportunity.

stagestring or nullOptionalformat: "uuid"

The stage of the opportunity.

statusenum or nullOptional

The opportunity’s status.

OPEN - OPEN
WON - WON
LOST - LOST

Allowed values:

last_activity_atdatetime or nullOptional

When the opportunity's last activity occurred.

close_datedatetime or nullOptional

When the opportunity was closed.

remote_created_atdatetime or nullOptional

When the third party's opportunity was created.

remote_fieldslist of objectsOptionalRead-only

Supported PATCH model parameters

namestring or nullOptional

The opportunity's name.

amountinteger or nullOptional-2147483648-2147483647

The opportunity's amount.

ownerstring or nullOptionalformat: "uuid"

The opportunity's owner.

accountstring or nullOptionalformat: "uuid"

The account of the opportunity.

stagestring or nullOptionalformat: "uuid"

The stage of the opportunity.

statusenum or nullOptional

The opportunity’s status.

OPEN - OPEN
WON - WON
LOST - LOST

Allowed values:

last_activity_atdatetime or nullOptional

When the opportunity's last activity occurred.

close_datedatetime or nullOptional

When the opportunity was closed.

remote_created_atdatetime or nullOptional

When the third party's opportunity was created.

remote_fieldslist of objectsOptionalRead-only

Supported PATCH model parameters

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The opportunity's name.

amountinteger or nullOptional-2147483648-2147483647

The opportunity's amount.

ownerstring or nullOptionalformat: "uuid"

The opportunity's owner.

accountstring or nullOptionalformat: "uuid"

The account of the opportunity.

stagestring or nullOptionalformat: "uuid"

The stage of the opportunity.

statusenum or nullOptional

The opportunity’s status.

OPEN - OPEN
WON - WON
LOST - LOST

Allowed values:

last_activity_atdatetime or nullOptional

When the opportunity's last activity occurred.

close_datedatetime or nullOptional

When the opportunity was closed.

remote_created_atdatetime or nullOptional

When the third party's opportunity was created.

Supported PATCH model parameters

namestring or nullOptional

The opportunity's name.

descriptionstring or nullOptional

The opportunity's description.

amountinteger or nullOptional-2147483648-2147483647

The opportunity's amount.

ownerstring or nullOptionalformat: "uuid"

The opportunity's owner.

accountstring or nullOptionalformat: "uuid"

The account of the opportunity.

stagestring or nullOptionalformat: "uuid"

The stage of the opportunity.

statusenum or nullOptional

The opportunity’s status.

OPEN - OPEN
WON - WON
LOST - LOST

Allowed values:

last_activity_atdatetime or nullOptional

When the opportunity's last activity occurred.

close_datedatetime or nullOptional

When the opportunity was closed.

remote_created_atdatetime or nullOptional

When the third party's opportunity was created.

remote_fieldslist of objectsOptionalRead-only

Supported PATCH model parameters

namestring or nullOptional

The opportunity's name.

descriptionstring or nullOptional

The opportunity's description.

amountinteger or nullOptional-2147483648-2147483647

The opportunity's amount.

ownerstring or nullOptionalformat: "uuid"

The opportunity's owner.

accountstring or nullOptionalformat: "uuid"

The account of the opportunity.

stagestring or nullOptionalformat: "uuid"

The stage of the opportunity.

last_activity_atdatetime or nullOptional

When the opportunity's last activity occurred.

close_datedatetime or nullOptional

When the opportunity was closed.

remote_created_atdatetime or nullOptional

When the third party's opportunity was created.

/opportunities/{id}

Authentication

Path parameters

Headers

Query parameters

Request

Description

Usage Example

Response

Description

Usage Example

Field support by integration

Field support by integration