Skip to main content

Update opportunity

PATCH 

/opportunities/:opportunity_id

Update opportunity

Request

Path Parameters

    opportunity_id stringrequired
    Example: c9f58083-a370-47b5-ad02-99160ea20372

Header Parameters

    x-customer-id stringrequired

    The customer ID that uniquely identifies the customer in your application

    Example: my-customer-1
    x-provider-name stringrequired

    The provider name

    Example: salesforce

Body

required
    record objectrequired
    amount integernullable
    close_date stringnullable
    description stringnullable
    name stringnullable
    stage string
    account_id stringnullable
    owner_id stringnullable
    pipeline stringnullable
    custom_fields object

    Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.

    property name* any

    Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.

Responses

Opportunity updated

Schema
    errors object[]
  • Array [
  • id stringrequired

    A unique identifier for the instance of the error. Provide this to support when contacting Supaglue.

    detail stringrequired

    A detailed description of the error.

    problem_type stringdeprecated

    The Supaglue error code associated with the error.

    title stringrequired

    A brief description of the error. The schema and type of message will vary by Provider.

    code stringrequired

    The Supaglue error code associated with the error.

    status stringrequired

    The HTTP status code associated with the error.

    meta objectrequired

    Additional metadata about the error.

    cause object

    The cause of the error. Usually the underlying error from the remote Provider.

    origin stringrequired

    Possible values: [remote-provider, supaglue]

    The origin of the error.

    application_name string

    The name of the application that generated the error.

    property name* any

    Additional metadata about the error.

  • ]
  • warnings object[]
  • Array [
  • detail string
    problem_type string
    title string
  • ]
Loading...