Opportunities

openapi: 3.0.3 info: title: Salesforce Proxy API - Opportunities version: v1 description: API to interact with Salesforce Proxy contact: name: Salesforce Proxy url: https://www.jackhenry.com/ email: DC-Operations@jackhenry.com servers: - url: https://{API_ENDPOINT} variables: API_ENDPOINT: default: digital.garden-fi.com security: - bearerAuth: [] tags: - name: Opportunities description: Salesforce sales opportunities. paths: /a/api/salesforce-proxy/v1/{InstitutionUniversalId}/opportunities: post: operationId: createOpportunity tags: - Opportunities description: Create a new sales opportunity in Salesforce for the given institution. parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: description: Opportunity resource to be created. required: true content: application/json: schema: type: object required: - userName - productName properties: userName: type: string description: The name of the user creating the opportunity. productName: type: string description: The name of the product for the opportunity. responses: '201': description: Successful create. content: application/json: schema: type: object properties: id: type: string description: The Salesforce opportunity identifier. name: type: string description: The opportunity name. stageName: type: string description: The current stage of the opportunity. closeDate: type: string format: date-time description: The expected close date. createdDate: type: string format: date-time description: The date the opportunity was created. lastModifiedDate: type: string format: date-time description: The date the opportunity was last modified. isClosed: type: boolean description: Whether the opportunity is closed. isWon: type: boolean description: Whether the opportunity was won. '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string fieldDetails: type: array description: An array of objects which provide additional details to specific fields in the request that caused the error. items: type: object properties: field: type: string description: The name or path of the field in the request that caused the error. detail: type: string description: A end-user readable message describing the error related to the field. data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/salesforce-proxy/v1/{InstitutionUniversalId}/opportunities/{opportunityId}: get: operationId: getOpportunity tags: - Opportunities description: Retrieve a specific opportunity by ID, scoped to the given institution. parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: opportunityId in: path required: true schema: type: string description: The Salesforce opportunity identifier. responses: '200': description: Successful retrieve. content: application/json: schema: type: object properties: id: type: string description: The Salesforce opportunity identifier. name: type: string description: The opportunity name. stageName: type: string description: The current stage of the opportunity. closeDate: type: string format: date-time description: The expected close date. createdDate: type: string format: date-time description: The date the opportunity was created. lastModifiedDate: type: string format: date-time description: The date the opportunity was last modified. isClosed: type: boolean description: Whether the opportunity is closed. isWon: type: boolean description: Whether the opportunity was won. '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error

Please ignore this field