---
agentTools:
  projectIndex: https://docs.concept.partner.elliemae.com/llms.txt
---

# Update transaction response

Update transaction response with new data and resources. Only partners can update transaction response.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Partner RESTful API",
    "description": "API definition document for the Encompass Partner Connect RESTful API",
    "termsOfService": "https://www.elliemae.com/content/agreements/encompass-partner-connect-api-terms-and-conditions.pdf",
    "contact": {
      "name": "Encompass Partner Connect Support",
      "url": "https://wwww.elliemae.com",
      "email": "DL_EPC_Support@elliemae.com"
    },
    "license": {
      "name": "Apache 2.0",
      "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
    },
    "version": "2.0"
  },
  "tags": [
    {
      "name": "Transaction Response",
      "description": "Operations on the transaction response resource"
    }
  ],
  "paths": {
    "/v2/transactions/{transactionId}/response": {
      "put": {
        "tags": [
          "Transaction Response"
        ],
        "summary": "Update transaction response",
        "description": "Update transaction response with new data and resources. Only partners can update transaction response.",
        "operationId": "putTransactionResponseUsingPUT",
        "parameters": [
          {
            "name": "transactionId",
            "in": "path",
            "description": "transactionId",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "$ref": "#/components/requestBodies/ResponseDTO"
        },
        "responses": {
          "201": {
            "description": "Created"
          },
          "204": {
            "description": "No Content",
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/ResponseEntity"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "Forbidden"
          },
          "404": {
            "description": "Not Found"
          }
        },
        "security": [
          {
            "JWT": [
              "global"
            ]
          }
        ]
      }
    }
  },
  "externalDocs": {
    "url": "https://docs.partnerconnect.elliemae.com/",
    "description": "Encompass Partner Connect"
  },
  "x-explorer-enabled": true,
  "x-samples-languages": [
    "curl",
    "node",
    "python",
    "csharp",
    "java",
    "php",
    "ruby"
  ],
  "x-readme": {
    "proxy-enabled": true,
    "samples-enabled": true
  },
  "servers": [
    {
      "url": "//api.elliemae.com/partner/v2"
    }
  ],
  "components": {
    "requestBodies": {
      "ResponseDTO": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ResponseDTO"
            }
          }
        },
        "description": "response",
        "required": true
      }
    },
    "securitySchemes": {
      "JWT": {
        "type": "apiKey",
        "name": "Authorization",
        "in": "header"
      }
    },
    "schemas": {
      "EpcError": {
        "type": "object",
        "required": [
          "code",
          "description"
        ],
        "properties": {
          "code": {
            "type": "string",
            "description": "Code identifying the specific error message"
          },
          "description": {
            "type": "string",
            "description": "Detailed description of the error"
          },
          "fieldId": {
            "type": "string",
            "description": "Field identifier when dealing with errors related to field data"
          },
          "resourceId": {
            "type": "string",
            "description": "Resource identifier when dealing with errors related to resource data"
          },
          "type": {
            "type": "string",
            "description": "Provides additional information around the type or source of the error"
          }
        },
        "title": "EpcError"
      },
      "OrganizationDTO": {
        "type": "object",
        "properties": {
          "address": {
            "type": "string",
            "description": "Address"
          },
          "city": {
            "type": "string",
            "description": "City"
          },
          "name": {
            "type": "string",
            "description": "Name"
          },
          "pointOfContact": {
            "$ref": "#/components/schemas/PointOfContactDTO"
          },
          "postalCode": {
            "type": "string",
            "description": "Postal code"
          },
          "state": {
            "type": "string",
            "description": "State"
          }
        },
        "title": "OrganizationDTO"
      },
      "PointOfContactDTO": {
        "type": "object",
        "properties": {
          "email": {
            "type": "string",
            "description": "Email"
          },
          "fax": {
            "type": "string",
            "description": "Fax"
          },
          "name": {
            "type": "string",
            "description": "Name"
          },
          "personas": {
            "type": "array",
            "description": "Personas",
            "items": {
              "type": "string"
            }
          },
          "phone": {
            "type": "string",
            "description": "Phone"
          },
          "role": {
            "type": "string",
            "description": "Role"
          }
        },
        "title": "PointOfContactDTO"
      },
      "AssignedTo": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          }
        },
        "title": "AssignedTo"
      },
      "DisplayFieldDTO": {
        "type": "object",
        "properties": {
          "label": {
            "type": "string",
            "description": "label of the field",
            "minLength": 0,
            "maxLength": 256
          },
          "value": {
            "type": "string",
            "description": "value of the field",
            "minLength": 0,
            "maxLength": 256
          }
        },
        "title": "DisplayFieldDTO"
      },
      "MissingDataDTO": {
        "type": "object",
        "properties": {
          "fields": {
            "type": "array",
            "description": "List of missing fields",
            "items": {
              "type": "string"
            }
          }
        },
        "title": "MissingDataDTO"
      },
      "ResourceContainerDTO": {
        "type": "object",
        "properties": {
          "description": {
            "type": "string"
          },
          "metadata": {
            "type": "object"
          },
          "name": {
            "type": "string"
          },
          "type": {
            "type": "string"
          }
        },
        "title": "ResourceContainerDTO"
      },
      "ResourceDTO": {
        "type": "object",
        "properties": {
          "assignedTo": {
            "$ref": "#/components/schemas/AssignedTo"
          },
          "authorization": {
            "type": "string",
            "description": "Authorization token to access the resource"
          },
          "contentLength": {
            "type": "integer",
            "format": "int32"
          },
          "docType": {
            "type": "string",
            "description": "Document type"
          },
          "id": {
            "type": "string",
            "description": "Unique identifier of the resource in a repository such as Skydrive"
          },
          "location": {
            "type": "string",
            "description": "Resource location"
          },
          "mimeType": {
            "type": "string",
            "description": "Resource mime type"
          },
          "name": {
            "type": "string",
            "description": "Resource name"
          },
          "nonDownloadable": {
            "type": "boolean",
            "description": "Flag to restrict downloadable access"
          },
          "overrideResources": {
            "type": "boolean",
            "description": "Override Resources"
          },
          "type": {
            "type": "string",
            "description": "Resource type",
            "minLength": 0,
            "maxLength": 256,
            "pattern": "^urn:ice:epc:partner:appraisal:report:version:(V\\d+(\\.\\d+){0,2})$|^(?!urn:ice:epc:partner:appraisal:report:version:).*"
          },
          "unassigned": {
            "type": "boolean",
            "description": "Unassigned resource flag"
          }
        },
        "title": "ResourceDTO"
      },
      "ResponseDTO": {
        "type": "object",
        "properties": {
          "displayFields": {
            "type": "array",
            "description": "Display fields",
            "items": {
              "$ref": "#/components/schemas/DisplayFieldDTO"
            }
          },
          "errors": {
            "type": "array",
            "description": "Used by the partner to indicate errors within their fulfillment process.",
            "items": {
              "$ref": "#/components/schemas/EpcError"
            }
          },
          "loan": {
            "type": "object",
            "description": "Partner Lending Model(PLM) containing lending system request entity details"
          },
          "loanFormat": {
            "type": "string",
            "description": "Indicator of which application PLM version is being used for the PLM data",
            "enum": [
              "PLM200JSON"
            ]
          },
          "missingData": {
            "$ref": "#/components/schemas/MissingDataDTO"
          },
          "partnerStatus": {
            "type": "string",
            "description": "Free Form Text from partner"
          },
          "referenceNumber": {
            "type": "string",
            "description": "Partner order number"
          },
          "resourceContainers": {
            "type": "array",
            "description": "Used by the partner to update eFolder container properties",
            "items": {
              "$ref": "#/components/schemas/ResourceContainerDTO"
            }
          },
          "resources": {
            "type": "array",
            "description": "Resources associated with a transaction",
            "items": {
              "$ref": "#/components/schemas/ResourceDTO"
            }
          },
          "respondingParty": {
            "$ref": "#/components/schemas/OrganizationDTO"
          },
          "result": {
            "type": "object",
            "description": "Used by the partner to send order result and metadata back to the lender system"
          },
          "results": {
            "type": "array",
            "description": "Used by the partner to send order result and metadata back to the lender system",
            "items": {
              "type": "object"
            }
          },
          "retry": {
            "$ref": "#/components/schemas/RetryDTO"
          },
          "status": {
            "type": "string",
            "description": "Transaction processing status from partner system",
            "enum": [
              "canceled",
              "completed",
              "failed",
              "inputRequired",
              "processing"
            ]
          }
        },
        "title": "ResponseDTO"
      },
      "ResponseEntity": {
        "type": "object",
        "properties": {
          "body": {
            "type": "object"
          },
          "statusCode": {
            "type": "string",
            "enum": [
              "ACCEPTED",
              "ALREADY_REPORTED",
              "BAD_GATEWAY",
              "BAD_REQUEST",
              "BANDWIDTH_LIMIT_EXCEEDED",
              "CHECKPOINT",
              "CONFLICT",
              "CONTINUE",
              "CREATED",
              "DESTINATION_LOCKED",
              "EXPECTATION_FAILED",
              "FAILED_DEPENDENCY",
              "FORBIDDEN",
              "FOUND",
              "GATEWAY_TIMEOUT",
              "GONE",
              "HTTP_VERSION_NOT_SUPPORTED",
              "IM_USED",
              "INSUFFICIENT_SPACE_ON_RESOURCE",
              "INSUFFICIENT_STORAGE",
              "INTERNAL_SERVER_ERROR",
              "I_AM_A_TEAPOT",
              "LENGTH_REQUIRED",
              "LOCKED",
              "LOOP_DETECTED",
              "METHOD_FAILURE",
              "METHOD_NOT_ALLOWED",
              "MOVED_PERMANENTLY",
              "MOVED_TEMPORARILY",
              "MULTIPLE_CHOICES",
              "MULTI_STATUS",
              "NETWORK_AUTHENTICATION_REQUIRED",
              "NON_AUTHORITATIVE_INFORMATION",
              "NOT_ACCEPTABLE",
              "NOT_EXTENDED",
              "NOT_FOUND",
              "NOT_IMPLEMENTED",
              "NOT_MODIFIED",
              "NO_CONTENT",
              "OK",
              "PARTIAL_CONTENT",
              "PAYLOAD_TOO_LARGE",
              "PAYMENT_REQUIRED",
              "PERMANENT_REDIRECT",
              "PRECONDITION_FAILED",
              "PRECONDITION_REQUIRED",
              "PROCESSING",
              "PROXY_AUTHENTICATION_REQUIRED",
              "REQUESTED_RANGE_NOT_SATISFIABLE",
              "REQUEST_ENTITY_TOO_LARGE",
              "REQUEST_HEADER_FIELDS_TOO_LARGE",
              "REQUEST_TIMEOUT",
              "REQUEST_URI_TOO_LONG",
              "RESET_CONTENT",
              "SEE_OTHER",
              "SERVICE_UNAVAILABLE",
              "SWITCHING_PROTOCOLS",
              "TEMPORARY_REDIRECT",
              "TOO_EARLY",
              "TOO_MANY_REQUESTS",
              "UNAUTHORIZED",
              "UNAVAILABLE_FOR_LEGAL_REASONS",
              "UNPROCESSABLE_ENTITY",
              "UNSUPPORTED_MEDIA_TYPE",
              "UPGRADE_REQUIRED",
              "URI_TOO_LONG",
              "USE_PROXY",
              "VARIANT_ALSO_NEGOTIATES"
            ]
          },
          "statusCodeValue": {
            "type": "integer",
            "format": "int32"
          }
        },
        "title": "ResponseEntity"
      },
      "RetryDTO": {
        "type": "object",
        "properties": {
          "duration": {
            "type": "integer",
            "format": "int32",
            "description": "Number of minutes to retry up til"
          },
          "interval": {
            "type": "string",
            "description": "The retry interval for the response"
          }
        },
        "title": "RetryDTO"
      }
    }
  },
  "_id": {
    "buffer": {
      "0": 102,
      "1": 30,
      "2": 86,
      "3": 68,
      "4": 51,
      "5": 49,
      "6": 232,
      "7": 0,
      "8": 15,
      "9": 227,
      "10": 195,
      "11": 228
    }
  }
}
```