Background Images

Upload background image

Uploads a background image for a project. Requires project manager permissions.

post/projects/{projectId}/background-images

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/projects/{projectId}/background-images
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Api-Key

Path parameters

projectIdstring required
Example:1357158568008091264

ID of the project to upload background image for

Response

Background image uploaded successfully

Example response

{
  "item": {
    "id": "1357158568008091264",
    "projectId": "1357158568008091265",
    "size": "1024576",
    "url": "https://storage.example.com/background-images/1357158568008091264/original.jpg",
    "thumbnailUrls": {
      "outside360": "https://storage.example.com/background-images/1357158568008091264/outside-360.jpg"
    },
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2024-01-01T00:00:00.000Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.