🤝 Ask or Offer Help Post#
Used to create posts under the "Ask and Offer Help" section, such as Introduction, Advice, Recommendation, Kudos, or Help. The postType determines the type of post being created.🔢 postType Reference#
| Post Type Name | Value |
|---|
| Introduction | 8 |
| Advice | 9 |
| Recommendation | 10 |
| Help | 11 |
| Kudos | 12 |
HTTP Method#
Endpoint#
| Name | Type | Required | Description |
|---|
| x-api-key | string | ✅ | Used to authorize the request. |
Body Parameters#
| Name | Type | Required | Description |
|---|
| postType | number | ✅ | Type of post (Refer to postType table above). |
| text | string | ✅ | The content or message of the post. |
| communities | string[] | ✅ | Array of community IDs where this post should be shared. |
| hideFromDiscover | boolean | ❌ | If true, the post will not appear in the public discover section (default: false). |
Sample Response#
{
"data": {
"postId": "688317e48582724f7cb79f3c",
"status": 4,
"communities": [
"67959032bc6bea0012fdc671"
]
},
"error": false,
"message": "Operation completed successfully"
}
Response Interface#
interface ICreatePostResponse {
data: {
postId: string;
status: number;
communities: string[];
};
error: boolean;
message: string;
}
Response Field Descriptions#
| Field | Type | Description |
|---|
| postId | string | Unique identifier of the newly created post. |
| status | number | Current status of the post (e.g., published, pending, etc.). |
| communities | string[] | List of community IDs where the post is to be published. |
| error | boolean | Indicates whether the request failed. |
| message | string | Human-readable status message. |
Reference#
Notes#
The same endpoint is used for all Ask/Offer Help post types. Just change the postType value accordingly.
Ensure the community ID is valid and that the API key has permission to post within it.
Modified at 2026-05-11 08:27:04
