Create Opportunity File (from URL) | Coperniq

curl -X POST https://api.coperniq.io/v1/opportunities/opportunityId/files \
     -H "x-api-key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "body": {
    "url": "https://files.coperniq.io/uploads/project-specifications.pdf"
  }
}'

{
  "id": 987654,
  "name": "project-specifications.pdf",
  "downloadUrl": "https://files.coperniq.io/downloads/project-specifications.pdf",
  "type": "application/pdf",
  "updatedAt": "2024-01-15T09:30:00Z",
  "createdAt": "2024-01-15T09:30:00Z",
  "metaData": {
    "acl": "private",
    "size": 245760,
    "userId": 12345,
    "mimeType": "application/pdf",
    "extention": "pdf",
    "originalName": "project-specifications.pdf",
    "generatedName": "proj_spec_987654.pdf",
    "gps": {},
    "thumbnailUrl": "https://files.coperniq.io/thumbnails/project-specifications-thumb.png",
    "thumbnailName": "proj_spec_987654-thumb.png",
    "requestFileName": "project-specifications.pdf"
  },
  "source": "INTERNAL",
  "createdByUser": {
    "id": 12345,
    "firstName": "Alice",
    "lastName": "Johnson"
  },
  "isArchived": false
}

Upload a file to an opportunity by providing its URL

Note: The /requests path is an alias for /opportunities and will continue to work until users are individually notified and migrated.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

opportunityIdstringRequired

Opportunity identifier

Request

This endpoint expects an object.

urlstringRequiredformat: "uri"

URL of the file to upload

namestringOptional

Name of the file

isArchivedbooleanOptionalDefaults to false

Whether the file is archived

phaseInstanceIdintegerOptional

Optional. The ID of the phase instance to use. If provided, the phase does not need to be started to upload a file. You can gather phase instance ids from the get opportunity endpoint.

Response

Successful response

idinteger

File identifier

namestring

File name

downloadUrlstring

URL to download the file

typestring

File type

updatedAtstringformat: "date-time"

Last update timestamp

createdAtstringformat: "date-time"

Creation timestamp

metaDataobject

sourcestring

File source (e.g., INTERNAL)

createdByUserobject

isArchivedboolean or null

Whether the file is archived

Authentication

Path parameters

Request

Response

Errors