openapi: 3.2.0 info: title: ClickFunnels Communities::Spaces::Post 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: Communities::Spaces::Post description: '> Posts are member-created content items within a Community Space. A Post belongs to a Space and is authored by a Contact. Posts support rich HTML body content, optional titles, pinning, and cover images. Posts created via the API are auto-approved. Use `Communities::Spaces::Post::Comment`, `Communities::Spaces::Post::Like`, and `Communities::Spaces::Post::VideoEmbed` to manage the sub-resources of a post. ' paths: /communities/spaces/{space_id}/posts: get: tags: - Communities::Spaces::Post summary: List Posts description: List posts for a space operationId: listCommunitiesSpacesPosts parameters: - name: space_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/CommunitiesSpacesPostAttributes' example: - id: 101 public_id: AbCdEf contact_id: 55 title: Welcome to the community! body: Hi everyone, excited to be here. url: https://example.myclickfunnels.com/communities/posts/AbCdEf contact: id: 55 public_id: GhIjKl email_address: jane@example.com first_name: Jane last_name: Doe phone_number: null group: id: 1 public_id: BcDeFg name: General topic: id: 2 public_id: CdEfGh name: Introductions 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' post: tags: - Communities::Spaces::Post summary: Create Post description: Create a post in a space. Posts created via the API are auto-approved. The `contact_id` is optional and defaults to the connected user's own contact. operationId: createCommunitiesSpacesPosts parameters: - name: space_id in: path required: true schema: type: string requestBody: description: Information about a new Post required: true content: application/json: schema: type: object properties: communities_spaces_post: type: object $ref: '#/components/schemas/CommunitiesSpacesPostParameters' example: communities_spaces_post: title: Welcome to the community! body:
Hi everyone, excited to be here.
responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/CommunitiesSpacesPostAttributes' example: id: 101 public_id: AbCdEf contact_id: 55 title: Welcome to the community! body: Hi everyone, excited to be here. url: https://example.myclickfunnels.com/communities/posts/AbCdEf contact: id: 55 public_id: GhIjKl email_address: jane@example.com first_name: Jane last_name: Doe phone_number: null group: id: 1 public_id: BcDeFg name: General topic: id: 2 public_id: CdEfGh name: Introductions 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 '422': description: Unprocessable Entity content: application/json: schema: type: object properties: error: type: string example: error: Title can't be blank /communities/spaces/posts/{id}: get: tags: - Communities::Spaces::Post summary: Fetch Post description: Retrieve a post operationId: getCommunitiesSpacesPosts parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CommunitiesSpacesPostAttributes' example: id: 101 public_id: AbCdEf contact_id: 55 title: Welcome to the community! body: Hi everyone, excited to be here. url: https://example.myclickfunnels.com/communities/posts/AbCdEf contact: id: 55 public_id: GhIjKl email_address: jane@example.com first_name: Jane last_name: Doe phone_number: null group: id: 1 public_id: BcDeFg name: General topic: id: 2 public_id: CdEfGh name: Introductions 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: - Communities::Spaces::Post summary: Update Post description: Update a post. The `contact_id` field is ignored on update. operationId: updateCommunitiesSpacesPosts parameters: - $ref: '#/components/parameters/id' requestBody: description: Information about updated fields in Post required: true content: application/json: schema: type: object properties: communities_spaces_post: type: object $ref: '#/components/schemas/CommunitiesSpacesPostParametersUpdate' example: communities_spaces_post: title: Updated post title is_pinned: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CommunitiesSpacesPostAttributes' example: id: 101 public_id: AbCdEf contact_id: 55 title: Updated post title body: Hi everyone, excited to be here. url: https://example.myclickfunnels.com/communities/posts/AbCdEf contact: id: 55 public_id: GhIjKl email_address: jane@example.com first_name: Jane last_name: Doe phone_number: null group: id: 1 public_id: BcDeFg name: General topic: id: 2 public_id: CdEfGh name: Introductions 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: - Communities::Spaces::Post summary: Remove Post description: Delete a post operationId: removeCommunitiesSpacesPosts 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' /communities/spaces/posts/{id}/approve: post: tags: - Communities::Spaces::Post summary: Approve Post description: Approve a post. Sets `approved_at` to the current time, applies any pending draft edit to the live body, and notifies any contacts mentioned in the post body. operationId: approveCommunitiesSpacesPost parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CommunitiesSpacesPostAttributes' example: id: 101 public_id: AbCdEf contact_id: 55 title: Welcome to the community! body: Hi everyone, excited to be here. url: https://example.myclickfunnels.com/communities/posts/AbCdEf contact: id: 55 public_id: GhIjKl email_address: jane@example.com first_name: Jane last_name: Doe phone_number: null group: id: 1 public_id: BcDeFg name: General topic: id: 2 public_id: CdEfGh name: Introductions 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 '403': description: Forbidden content: application/json: schema: type: object properties: error: type: string example: error: Forbidden '404': description: Not Found content: application/json: schema: type: object properties: error: type: string example: error: 'Not found: Record missing' /communities/spaces/posts/{id}/decline: post: tags: - Communities::Spaces::Post summary: Decline Post description: Decline a post. Sets `declined_at` to the current time, marking the post as rejected and hiding it from the community feed. operationId: declineCommunitiesSpacesPost parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CommunitiesSpacesPostAttributes' example: id: 101 public_id: AbCdEf contact_id: 55 title: Welcome to the community! body: Hi everyone, excited to be here. url: https://example.myclickfunnels.com/communities/posts/AbCdEf contact: id: 55 public_id: GhIjKl email_address: jane@example.com first_name: Jane last_name: Doe phone_number: null group: id: 1 public_id: BcDeFg name: General topic: id: 2 public_id: CdEfGh name: Introductions 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 '403': description: Forbidden content: application/json: schema: type: object properties: error: type: string example: error: Forbidden '404': description: Not Found content: application/json: schema: type: object properties: error: type: string example: error: 'Not found: Record missing' /communities/spaces/posts/{id}/dismiss_reports: post: tags: - Communities::Spaces::Post summary: Dismiss Reports on Post description: Dismiss all pending moderation reports on a post. Clears the report flags and approves the post, making it visible in the community feed. operationId: dismissReportsCommunitiesSpacesPost parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CommunitiesSpacesPostAttributes' example: id: 101 public_id: AbCdEf contact_id: 55 title: Welcome to the community! body: Hi everyone, excited to be here. url: https://example.myclickfunnels.com/communities/posts/AbCdEf contact: id: 55 public_id: GhIjKl email_address: jane@example.com first_name: Jane last_name: Doe phone_number: null group: id: 1 public_id: BcDeFg name: General topic: id: 2 public_id: CdEfGh name: Introductions 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 '403': description: Forbidden content: application/json: schema: type: object properties: error: type: string example: error: Forbidden '404': description: Not Found content: application/json: schema: type: object properties: error: type: string example: error: 'Not found: Record missing' /communities/spaces/posts/{id}/pin: post: tags: - Communities::Spaces::Post summary: Pin Post description: Pin a post. Sets `is_pinned` to true, causing the post to appear at the top of the community space feed. operationId: pinCommunitiesSpacesPost parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CommunitiesSpacesPostAttributes' example: id: 101 public_id: AbCdEf contact_id: 55 title: Welcome to the community! body: Hi everyone, excited to be here. url: https://example.myclickfunnels.com/communities/posts/AbCdEf contact: id: 55 public_id: GhIjKl email_address: jane@example.com first_name: Jane last_name: Doe phone_number: null group: id: 1 public_id: BcDeFg name: General topic: id: 2 public_id: CdEfGh name: Introductions 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 '403': description: Forbidden content: application/json: schema: type: object properties: error: type: string example: error: Forbidden '404': description: Not Found content: application/json: schema: type: object properties: error: type: string example: error: 'Not found: Record missing' /communities/spaces/posts/{id}/unpin: post: tags: - Communities::Spaces::Post summary: Unpin Post description: Unpin a post. Sets `is_pinned` to false, removing the post from the pinned section at the top of the community space feed. operationId: unpinCommunitiesSpacesPost parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CommunitiesSpacesPostAttributes' example: id: 101 public_id: AbCdEf contact_id: 55 title: Welcome to the community! body: Hi everyone, excited to be here. url: https://example.myclickfunnels.com/communities/posts/AbCdEf contact: id: 55 public_id: GhIjKl email_address: jane@example.com first_name: Jane last_name: Doe phone_number: null group: id: 1 public_id: BcDeFg name: General topic: id: 2 public_id: CdEfGh name: Introductions 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 '403': description: Forbidden content: application/json: schema: type: object properties: error: type: string example: error: Forbidden '404': description: Not Found content: application/json: schema: type: object properties: error: type: string example: error: 'Not found: Record missing' components: schemas: CommunitiesSpacesPostParametersUpdate: type: object title: Communities::Spaces::Post description: Communities::Spaces::Post properties: title: type: - string - 'null' description: Post title body: type: - string - 'null' description: Post body as rich HTML image_id: type: - integer - 'null' description: Cover image ID is_pinned: type: - boolean - 'null' description: Whether to pin the post at the top of the space current_path: type: - string - 'null' description: Current path (used for tracking purposes) example: communities_spaces_post: title: Updated post title is_pinned: true CommunitiesSpacesPostAttributes: type: object title: Communities::Spaces::Post description: Communities::Spaces::Post properties: id: type: integer description: Post ID public_id: type: - string - 'null' description: Post public ID contact_id: type: - integer - 'null' description: ID of the Contact who authored the post title: type: - string - 'null' description: Post title body: type: - string - 'null' description: Post body as plain text url: type: - string - 'null' description: Canonical URL of the post contact: description: Short representation of the authoring Contact, or null if the contact has been deleted type: - object - 'null' properties: id: type: integer description: Contact ID public_id: type: string description: Contact public ID email_address: type: - string - 'null' description: Contact email address first_name: type: - string - 'null' description: Contact first name last_name: type: - string - 'null' description: Contact last name phone_number: type: - string - 'null' description: Contact phone number group: description: The Space Group this post belongs to type: object properties: id: type: integer description: Space Group ID public_id: type: - string - 'null' description: Space Group public ID name: type: - string - 'null' description: Space Group name topic: description: The Space (topic) this post belongs to type: object properties: id: type: integer description: Space ID public_id: type: - string - 'null' description: Space public ID name: type: - string - 'null' description: Space name created_at: type: - string - 'null' format: date-time description: Created at updated_at: type: - string - 'null' format: date-time description: Updated at example: id: 101 public_id: AbCdEf contact_id: 55 title: Welcome to the community! body: Hi everyone, excited to be here. url: https://example.myclickfunnels.com/communities/posts/AbCdEf contact: id: 55 public_id: GhIjKl email_address: jane@example.com first_name: Jane last_name: Doe phone_number: null group: id: 1 public_id: BcDeFg name: General topic: id: 2 public_id: CdEfGh name: Introductions created_at: '2025-01-01T00:00:00.000Z' updated_at: '2025-01-01T00:00:00.000Z' required: - body - contact - contact_id - created_at - group - id - public_id - title - topic - updated_at - url CommunitiesSpacesPostParameters: type: object title: Communities::Spaces::Post description: Communities::Spaces::Post required: - title properties: title: type: string description: Post title body: type: - string - 'null' description: Post body as rich HTML contact_id: type: - integer - 'null' description: ID of the Contact to author the post. Optional — defaults to the connected user's own contact. image_id: type: - integer - 'null' description: Cover image ID is_pinned: type: - boolean - 'null' description: Whether to pin the post at the top of the space current_path: type: - string - 'null' description: Current path (used for tracking purposes) example: communities_spaces_post: title: Welcome to the community! body:Hi everyone, excited to be here.
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). 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