Create benefit
create_benefitCreate a benefit (member perk), the same as saving the Partner Hub's benefit form. An independent copy is created in each venue of venueIds (public ids from list_venues) and the response lists every copy. Requires the admin role on those venues. For a new photo, call import_image first and pass its image as content.image. Text fields are localized strings: { default: "…" } plus optional per-locale translations such as fi or en. activation needs validFrom (ISO datetime; the current time for a benefit available right away), validUntil (null for no end date) and frequency (how often one member can activate it). visibleToStatusCards (ids from list_status_cards) limits it to holders of those membership cards; omit it for every member. For a benefit created from the partner product catalogue (productVariantId), materialsOrder gives the shipping contact's name, email and phone for the free marketing materials sent to the venue. The benefit is live for members at once unless status is hidden, so confirm the details with the user before calling this.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"venueIds": "<venueIds>",
"content": "<content>",
"activation": "<activation>"
},
"name": "create_benefit"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| orgId | No | Organization public id, the `id` field from list_orgs. Omit it when the API key reaches exactly one organization. | |
| status | No | Effective hidden state: the venue's own hide toggle OR the campaign layer (see hiddenByCampaignAt) OR the partner-catalogue layer (see hiddenByProductAt) | active |
| content | Yes | ||
| venueIds | Yes | Venue IDs where this benefit is available | |
| sortOrder | No | ||
| activation | Yes | ||
| campaignId | No | ||
| templateId | No | Template ID used to create this benefit | |
| materialsOrder | No | Marketing-materials order, sent when the benefit is created from the partner product catalogue. Stored as a materials order per venue; ignored for a benefit not linked to a catalogue product. | |
| productVariantId | No | Partner product variant this benefit was created from | |
| visibleToStatusCards | No | Membership tier IDs. Undefined/empty = public benefit |