openapi: 3.2.0 info: title: ClickFunnels Image API termsOfService: https://www.clickfunnels.com/terms-of-service contact: name: ClickFunnels API Team url: https://developers.myclickfunnels.com x-logo: url: https://statics.myclickfunnels.com/image/1126065/file/31edf05760fafe41a82f16a668ab251f.png description: 'The ClickFunnels REST API that powers webhooks, native integrations, and Zapier lets you manage your ClickFunnels data, automate your workflows, and recreate ClickFunnels functionality in your own apps. ' license: name: MIT url: https://opensource.org/licenses/MIT version: 2.0.0 servers: - url: https://{subdomain}.myclickfunnels.com/api/v2 description: ClickFunnels API variables: subdomain: default: myworkspace security: - BearerAuth: [] tags: - name: Image description: '> Images can be used in a variety of use cases. An image can be created or updated from a URL by defining the `upload_source_url` parameter. The response returns the hosted `url` and the Image `id`. For a blog migration, create an Image for each source image, replace the source URL in the post body with the returned hosted `url`, and use the Image `id` as the blog post''s `image_id` only when it is the featured image. Keep a source-to-hosted URL map so repeated images are uploaded once. The same Image IDs can also be assigned to Products with the `image_ids` parameter. > Limitations and Constraints Images have a file size limit of 10MB and a dimension size limit of 10,000 x 10,000 pixels. Image file types currently supported include: ```shell # IMAGE TYPES jpeg, png, webp, x-icon, vnd.microsoft.icon # TEXT TYPES svg+xml, gif ``` Once uploaded, an image will return the following files and sizes | File Description | Width | Height | |--------------------------------------------------|--------------------|------------------------------------------------------------------------| | Thumbnail | 80 | 52 | | Small | 300 | 300 | | Medium | 600 | 600 | | Large | 800 | 800 | | X-Large | 2000 | 2000 | |--------------------------------------------------|--------------------|------------------------------------------------------------------------| ' paths: /workspaces/{workspace_id}/images: get: tags: - Image summary: List Images description: List Images operationId: listImages parameters: - name: workspace_id in: path required: true schema: type: string - $ref: '#/components/parameters/after' - $ref: '#/components/parameters/sort_order' - $ref: '#/components/parameters/sort_property' responses: '200': description: OK headers: Pagination-Next: $ref: '#/components/headers/PaginationNext' Link: $ref: '#/components/headers/Link' content: application/json: schema: type: array items: $ref: '#/components/schemas/ImageAttributes' example: - id: 106 public_id: jzMhsw url: https://example.myclickfunnels.com/uploads/image/1/file/9c8d1e7d480dc9882c519d4b4528826f.png workspace_id: 42000 alt_text: Alt text of the image name: Amazing Shot created_at: '2025-01-01T00:00:00.000Z' updated_at: '2025-01-01T00:00:00.000Z' - id: 107 public_id: TZjQMt url: https://example.myclickfunnels.com/uploads/image/1/file/9c8d1e7d480dc9882c519d4b4528826f.png workspace_id: 42000 alt_text: Alt text of the image name: Amazing Shot created_at: '2025-01-01T00:00:00.000Z' updated_at: '2025-01-01T00:00:00.000Z' '401': description: Unauthorized content: application/json: schema: type: object properties: error: type: string example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: type: object properties: error: type: string description: Not found - This usually happens when you try to access a record that does not exist in your account. It can also happen when the provided parent record is missing, e.g. you have put in a non-existent Workspaces parent ID. example: error: 'Not found: Record missing' post: tags: - Image summary: Create Image description: Create Image operationId: createImages parameters: - name: workspace_id in: path required: true schema: type: string requestBody: description: Information about a new Image required: true content: application/json: schema: type: object properties: image: type: object $ref: '#/components/schemas/ImageParameters' example: image: alt_text: Alt text of the image name: Amazing Shot upload_source_url: https://image-hosting-x.com/cdn/123 responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/ImageAttributes' example: id: 109 public_id: mjlqeI url: https://example.myclickfunnels.com/uploads/image/1/file/9c8d1e7d480dc9882c519d4b4528826f.png workspace_id: 42000 alt_text: Alt text of the image name: Amazing Shot created_at: '2025-01-01T00:00:00.000Z' updated_at: '2025-01-01T00:00:00.000Z' '400': description: Bad Request content: application/json: schema: type: object properties: error: type: string example: error: 'Bad request: HTTP body must be valid JSON' '401': description: Unauthorized content: application/json: schema: type: object properties: error: type: string example: error: API key missing or invalid /images/{id}: get: tags: - Image summary: Fetch Image description: Fetch Image operationId: getImages parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ImageAttributes' example: id: 108 public_id: liUmdt url: https://example.myclickfunnels.com/uploads/image/1/file/9c8d1e7d480dc9882c519d4b4528826f.png workspace_id: 42000 alt_text: Alt text of the image name: Amazing Shot created_at: '2025-01-01T00:00:00.000Z' updated_at: '2025-01-01T00:00:00.000Z' '401': description: Unauthorized content: application/json: schema: type: object properties: error: type: string example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: type: object properties: error: type: string example: error: 'Not found: Record missing' put: tags: - Image summary: Update Image description: Update Image operationId: updateImages parameters: - $ref: '#/components/parameters/id' requestBody: description: Information about updated fields in Image required: true content: application/json: schema: type: object properties: image: type: object $ref: '#/components/schemas/ImageParametersUpdate' example: image: alt_text: Alt text of the image name: Amazing Shot upload_source_url: https://image-hosting-x.com/cdn/123 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ImageAttributes' example: id: 111 public_id: GZazJR url: https://example.myclickfunnels.com/uploads/image/1/file/9c8d1e7d480dc9882c519d4b4528826f.png workspace_id: 42000 alt_text: Alt text of the image name: Amazing Shot created_at: '2025-01-01T00:00:00.000Z' updated_at: '2025-01-01T00:00:00.000Z' '400': description: Bad Request content: application/json: schema: type: object properties: error: type: string example: error: 'Bad request: HTTP body must be valid JSON' '401': description: Unauthorized content: application/json: schema: type: object properties: error: type: string example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: type: object properties: error: type: string example: error: 'Not found: Record missing' delete: tags: - Image summary: Remove Image description: Remove Image operationId: removeImages parameters: - $ref: '#/components/parameters/id' responses: '204': description: No Content '401': description: Unauthorized content: application/json: schema: type: object properties: error: type: string example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: type: object properties: error: type: string example: error: 'Not found: Record missing' components: parameters: id: name: id in: path required: true schema: type: string sort_property: name: sort_property in: query description: 'Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values. ' required: false schema: type: string enum: - id - updated_at sort_order: name: sort_order in: query description: Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). required: false schema: type: string enum: - asc - desc after: name: after in: query required: false schema: type: string description: ID of item after which the collection should be returned. More examples and info about pagination [in our guides](https://developers.myclickfunnels.com/docs/pagination). schemas: ImageParameters: type: object title: Images description: Images required: - upload_source_url properties: alt_text: type: - string - 'null' description: Image alt attribute name: type: - string - 'null' description: Image name upload_source_url: type: string description: The source URL of the image that you want to upload. Not required on Update when not needed to re-upload the image. example: image: alt_text: Alt text of the image name: Amazing Shot upload_source_url: https://image-hosting-x.com/cdn/123 ImageAttributes: type: object title: Images description: Images properties: id: type: integer description: Image ID public_id: type: - string - 'null' description: Public ID url: type: string description: The URL of the image workspace_id: type: integer description: Workspace ID alt_text: type: - string - 'null' description: Image alt attribute name: type: - string - 'null' description: Image name created_at: type: - string - 'null' format: date-time description: Added updated_at: type: - string - 'null' format: date-time description: Updated example: id: 11 public_id: CGFcPI url: https://example.myclickfunnels.com/uploads/image/1/file/9c8d1e7d480dc9882c519d4b4528826f.png workspace_id: 42000 alt_text: Alt text of the image name: Amazing Shot created_at: '2025-01-01T00:00:00.000Z' updated_at: '2025-01-01T00:00:00.000Z' required: - alt_text - created_at - id - name - public_id - updated_at - url - workspace_id ImageParametersUpdate: type: object title: Images description: Images required: [] properties: alt_text: type: - string - 'null' description: Image alt attribute name: type: - string - 'null' description: Image name upload_source_url: type: string description: The source URL of the image that you want to upload. Not required on Update when not needed to re-upload the image. example: image: alt_text: Alt text of the image name: Amazing Shot upload_source_url: https://image-hosting-x.com/cdn/123 headers: Link: description: A direct link to the next page for the cursor-based pagination. It includes the `after` and the Pagination-Next ID value. schema: type: string PaginationNext: description: ID of the last item in the current response after which more records exist. You can use it in an `after` query parameter for cursor-based pagination to get to the next page. schema: type: string securitySchemes: BearerAuth: type: http scheme: bearer externalDocs: description: More in-depth guides and further resources url: https://developers.myclickfunnels.com