> ## Documentation Index > Fetch the complete documentation index at: https://docs.spott.io/llms.txt > Use this file to discover all available pages before exploring further. # Update an opportunity > Updates the opportunity with the specified ID. You can update stage, close date, and other opportunity properties. ## OpenAPI ````yaml /api-reference/openapi.json patch /opportunities/{id} openapi: 3.1.0 info: title: Spott API Reference version: '0.1' servers: - url: https://api.gospott.com security: [] tags: [] paths: /opportunities/{id}: patch: tags: - Opportunities summary: Update an opportunity description: >- Updates the opportunity with the specified ID. You can update stage, close date, and other opportunity properties. operationId: updateOpportunity parameters: - name: id required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateOpportunityDto' responses: '204': description: Opportunity updated successfully headers: RateLimit: $ref: '#/components/headers/RateLimit' RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' '400': description: Bad request - missing or invalid required fields content: application/json: schema: $ref: '#/components/schemas/ExceptionBaseDto' headers: RateLimit: $ref: '#/components/headers/RateLimit' RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' '401': description: Unauthorized - invalid or missing authentication content: application/json: schema: $ref: '#/components/schemas/ExceptionBaseDto' headers: RateLimit: $ref: '#/components/headers/RateLimit' RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' '404': description: Opportunity not found content: application/json: schema: $ref: '#/components/schemas/ExceptionBaseDto' headers: RateLimit: $ref: '#/components/headers/RateLimit' RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' '409': description: Conflict content: application/json: schema: $ref: '#/components/schemas/GlobalConflictApiErrorDto' headers: RateLimit: $ref: '#/components/headers/RateLimit' RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' '429': description: >- Too Many Requests. The published limit for this endpoint is 600 requests per minute per workspace. The limit in force for your workspace can differ from it in either direction — a workspace on a free trial can be capped lower, and a higher limit can be arranged through support — so the headers, not this number, are authoritative. Read the RateLimit-Policy response header for the quota actually in force and RateLimit for what is left of the current window; on a 429, Retry-After gives the seconds to wait. content: application/json: schema: $ref: '#/components/schemas/ExceptionBaseDto' headers: RateLimit: $ref: '#/components/headers/RateLimit' RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' Retry-After: $ref: '#/components/headers/Retry-After' '500': description: Error response content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorDto' headers: RateLimit: $ref: '#/components/headers/RateLimit' RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' security: - x-api-key: [] components: schemas: UpdateOpportunityDto: type: object properties: companyId: type: string minLength: 1 description: The ID of the company this opportunity belongs to name: type: string minLength: 1 description: The name of the opportunity description: description: Detailed description of the opportunity type: - string - 'null' stageId: description: The pipeline stage ID type: string minLength: 1 ownerId: description: >- The user ID of the opportunity owner. Set to null to remove the owner. anyOf: - type: string minLength: 1 - type: 'null' closeDate: description: The target close date. Set to null to clear the close date. anyOf: - $ref: '#/components/schemas/UpdateOpportunityCloseDateDto' - type: 'null' clientTeam: description: Client contacts to associate with this opportunity maxItems: 50 type: array items: $ref: '#/components/schemas/IdDto' locations: description: >- Physical locations for the opportunity (0 to 15). Omit to leave unchanged; send an empty array to clear all. maxItems: 15 type: array items: $ref: '#/components/schemas/CreateLocationDto' ExceptionBaseDto: type: object properties: status: type: integer minimum: -9007199254740991 maximum: 9007199254740991 category: $ref: '#/components/schemas/ApiErrorCategoryDto' message: type: string requestId: type: string required: - status - message - requestId GlobalConflictApiErrorDto: anyOf: - $ref: '#/components/schemas/ResourceAlreadyExistsApiErrorDto' - $ref: '#/components/schemas/ResourceLockTimeoutApiErrorDto' InternalServerErrorDto: type: object properties: status: type: number const: 500 category: type: string enum: - INTERNAL_ERROR message: type: string enum: - Internal server error requestId: type: string required: - status - category - message - requestId UpdateOpportunityCloseDateDto: type: object properties: target: anyOf: - $ref: '#/components/schemas/DateISO' - type: 'null' description: Target close date for the opportunity required: - target IdDto: type: object properties: id: type: string minLength: 1 required: - id CreateLocationDto: type: object properties: street1: type: - string - 'null' street2: type: - string - 'null' postalCode: type: - string - 'null' city: type: - string - 'null' region: type: - string - 'null' state: type: - string - 'null' country: deprecated: true description: >- Deprecated: use `countryCode` instead. When omitted, the country name is derived from `countryCode`. type: - string - 'null' countryCode: anyOf: - $ref: '#/components/schemas/CountryCode' - type: 'null' latitude: anyOf: - type: number minimum: -90 maximum: 90 - type: 'null' longitude: anyOf: - type: number minimum: -180 maximum: 180 - type: 'null' type: anyOf: - $ref: '#/components/schemas/LocationType' - type: 'null' ApiErrorCategoryDto: type: string enum: - MALFORMED_REQUEST - SCHEMA_VALIDATION_FAILED - DOMAIN_VALIDATION_FAILED - OPERATION_LIMIT_EXCEEDED - AUTHENTICATION_REQUIRED - AUTHENTICATION_FAILED - SECURITY_CHALLENGE_REQUIRED - SECURITY_CHALLENGE_FAILED - PERMISSION_DENIED - ENTITLEMENT_REQUIRED - PROVIDER_AUTHENTICATION_REQUIRED - PROVIDER_AUTHENTICATION_FAILED - CONFIGURATION_REQUIRED - RESOURCE_NOT_FOUND - RESOURCE_ALREADY_EXISTS - RESOURCE_EXPIRED - RESOURCE_BUSY - RESOURCE_STATE_CONFLICT - QUOTA_EXCEEDED - RATE_LIMITED - UNSUPPORTED_OPERATION - UPSTREAM_REJECTED - TIMEOUT - TEMPORARILY_UNAVAILABLE - INTERNAL_ERROR ResourceAlreadyExistsApiErrorDto: type: object properties: status: type: number const: 409 category: type: string enum: - RESOURCE_ALREADY_EXISTS message: type: string enum: - Resource already exists requestId: type: string required: - status - category - message - requestId ResourceLockTimeoutApiErrorDto: type: object properties: status: type: number const: 409 category: type: string enum: - RESOURCE_BUSY message: type: string enum: - >- Lock could not be acquired for this resource, please try again later. requestId: type: string required: - status - category - message - requestId DateISO: format: date-time anyOf: - type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ - type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ CountryCode: type: string enum: - AF - AX - AL - DZ - AS - AD - AO - AI - AQ - AG - AR - AM - AW - AU - AT - AZ - BS - BH - BD - BB - BY - BE - BZ - BJ - BM - BT - BO - BQ - BA - BW - BV - BR - IO - BN - BG - BF - BI - KH - CM - CA - CV - KY - CF - TD - CL - CN - CX - CC - CO - KM - CG - CD - CK - CR - CI - HR - CU - CW - CY - CZ - DK - DJ - DM - DO - EC - EG - SV - GQ - ER - EE - ET - FK - FO - FJ - FI - FR - GF - PF - TF - GA - GM - GE - DE - GH - GI - GR - GL - GD - GP - GU - GT - GG - GN - GW - GY - HT - HM - VA - HN - HK - HU - IS - IN - ID - IR - IQ - IE - IM - IL - IT - JM - JP - JE - JO - KZ - KE - KI - KP - KR - KW - KG - LA - LV - LB - LS - LR - LY - LI - LT - LU - MO - MK - MG - MW - MY - MV - ML - MT - MH - MQ - MR - MU - YT - MX - FM - MD - MC - MN - ME - MS - MA - MZ - MM - NA - NR - NP - NL - NC - NZ - NI - NE - NG - NU - NF - MP - 'NO' - OM - PK - PW - PS - PA - PG - PY - PE - PH - PN - PL - PT - PR - QA - RE - RO - RU - RW - BL - SH - KN - LC - MF - PM - VC - WS - SM - ST - SA - SN - RS - SC - SL - SG - SX - SK - SI - SB - SO - ZA - GS - SS - ES - LK - SD - SR - SJ - SZ - SE - CH - SY - TW - TJ - TZ - TH - TL - TG - TK - TO - TT - TN - TR - TM - TC - TV - UG - UA - AE - GB - US - UM - UY - UZ - VU - VE - VN - VG - VI - WF - EH - XK - YE - ZM - ZW LocationType: type: string enum: - primary_home - secondary_home - primary_work - headquarters - regional_office headers: RateLimit: description: >- Quota state for this endpoint, as an RFC 8941 structured field (draft-ietf-httpapi-ratelimit-headers). The quoted value names the policy — the operationId of the endpoint the counters belong to. `r` is how many requests are left in the current window, `t` how many seconds remain before it resets. schema: type: string example: '"getCandidates";r=417;t=23' RateLimit-Policy: description: >- The policy the RateLimit header reports against, as an RFC 8941 structured field. `q` is the quota — the requests allowed per window — and `w` the window length in seconds. Limits are per endpoint, so the quota differs between operations. This is the quota in force for the calling workspace, which can be lower or higher than the default published on the operation; treat it as authoritative. schema: type: string example: '"getCandidates";q=600;w=60' Retry-After: description: >- Seconds to wait before retrying. Sent on 429 responses; it matches the `t` parameter of the RateLimit header. schema: type: integer example: 23 securitySchemes: x-api-key: type: apiKey name: x-api-key in: header description: >- API key for authentication. Get your API key from Settings → API Keys in your Spott dashboard. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.