BotStar

BotStar integration (Communication, Marketing). Imported from open-connector.

API key21 toolshttps://apis.botstar.com/v1

GET

bot_star_list_bots

List bots available to the configured BotStar API token.

/bots/

POST

bot_star_create_bot

Create a new BotStar bot.

/bots/

1 parameter

Param	Type	Required	Description
name	string	required	The new bot name.

GET

bot_star_get_bot

Get one BotStar bot by ID.

/bots/{botId}

1 parameter

Param	Type	Required	Description
botId	string	required	The BotStar bot ID.

GET

bot_star_list_bot_attributes

List attributes configured for a BotStar bot.

/bots/{botId}/attributes

2 parameters

Param	Type	Required	Description
botId	string	required	The BotStar bot ID.
env	string	optional	The BotStar environment to read or mutate.

POST

bot_star_create_bot_attribute

Create an attribute on a BotStar bot.

/bots/{botId}/attributes

7 parameters

Param	Type	Required	Description
botId	string	required	The BotStar bot ID.
env	string	optional	The BotStar environment target for mutation endpoints.
name	string	required	The bot attribute name.
data_type	string	required	The bot attribute data type.
desc	string	optional	The bot attribute description.
value	string	optional	A BotStar bot attribute value.
localizedValues	object	optional	Language-specific attribute values keyed by BotStar field name such as value_es.

PATCH

bot_star_update_bot_attribute

Update an existing BotStar bot attribute.

/bots/{botId}/attributes/{attributeId}

6 parameters

Param	Type	Required	Description
botId	string	required	The BotStar bot ID.
attributeId	string	required	The BotStar bot attribute ID.
env	string	optional	The BotStar environment target for mutation endpoints.
desc	string	optional	The updated bot attribute description.
value	string	optional	A BotStar bot attribute value.
localizedValues	object	optional	Language-specific attribute values keyed by BotStar field name such as value_es.

DELETE

bot_star_delete_bot_attribute

Delete a BotStar bot attribute.

/bots/{botId}/attributes/{attributeId}

3 parameters

Param	Type	Required	Description
botId	string	required	The BotStar bot ID.
attributeId	string	required	The BotStar bot attribute ID.
env	string	optional	The BotStar environment target for mutation endpoints.

POST

bot_star_publish_bot

Publish BotStar bot changes to the live environment.

/bots/{botId}/publish

1 parameter

Param	Type	Required	Description
botId	string	required	The BotStar bot ID.

GET

bot_star_get_user

Get a BotStar audience user by bot ID and user ID.

/bots/{botId}/users/{userId}

2 parameters

Param	Type	Required	Description
botId	string	required	The BotStar bot ID.
userId	string	required	The BotStar audience user ID.

PATCH

bot_star_update_user_attributes

Update attributes on a BotStar audience user.

/bots/{botId}/users/{userId}

3 parameters

Param	Type	Required	Description
botId	string	required	The BotStar bot ID.
userId	string	required	The BotStar audience user ID.
attributes	object	required	User attributes to update by BotStar field name.

POST

bot_star_create_user_attribute

Create a custom user attribute field for a BotStar bot.

/bots/{botId}/users/attributes

3 parameters

Param	Type	Required	Description
botId	string	required	The BotStar bot ID.
field_name	string	required	The custom user attribute field name.
field_type	string	required	The custom user attribute type.

GET

bot_star_list_cms_entities

List CMS entities configured for a BotStar bot.

/bots/{botId}/cms_entities

2 parameters

Param	Type	Required	Description
botId	string	required	The BotStar bot ID.
env	string	optional	The BotStar environment to read or mutate.

POST

bot_star_create_cms_entity

Create a BotStar CMS entity.

/bots/{botId}/cms_entities

4 parameters

Param	Type	Required	Description
botId	string	required	The BotStar bot ID.
env	string	optional	The BotStar environment target for mutation endpoints.
name	string	required	The CMS entity name.
fields	array	optional	Fields to create with the CMS entity.

GET

bot_star_get_cms_entity

Get one BotStar CMS entity by ID.

/bots/{botId}/cms_entities/{entityId}

3 parameters

Param	Type	Required	Description
botId	string	required	The BotStar bot ID.
entityId	string	required	The BotStar CMS entity ID.
env	string	optional	The BotStar environment to read or mutate.

PATCH

bot_star_update_cms_entity

Update a BotStar CMS entity.

/bots/{botId}/cms_entities/{entityId}

4 parameters

Param	Type	Required	Description
botId	string	required	The BotStar bot ID.
entityId	string	required	The BotStar CMS entity ID.
env	string	optional	The BotStar environment target for mutation endpoints.
name	string	required	The updated CMS entity name.

DELETE

bot_star_delete_cms_entity

Delete a BotStar CMS entity.

/bots/{botId}/cms_entities/{entityId}

3 parameters

Param	Type	Required	Description
botId	string	required	The BotStar bot ID.
entityId	string	required	The BotStar CMS entity ID.
env	string	optional	The BotStar environment target for mutation endpoints.

GET

bot_star_list_cms_entity_items

List items in a BotStar CMS entity.

/bots/{botId}/cms_entities/{entityId}/items

7 parameters

Param	Type	Required	Description
botId	string	required	The BotStar bot ID.
entityId	string	required	The BotStar CMS entity ID.
env	string	optional	The BotStar environment to read or mutate.
page	integer	optional	The 1-based page number to request.
limit	integer	optional	The maximum number of items to return.
name	string	optional	Filter CMS entity items by name.
status	string	optional	The BotStar CMS entity item status.

POST

bot_star_create_cms_entity_item

Create an item in a BotStar CMS entity.

/bots/{botId}/cms_entities/{entityId}/items

6 parameters

Param	Type	Required	Description
botId	string	required	The BotStar bot ID.
entityId	string	required	The BotStar CMS entity ID.
env	string	optional	The BotStar environment target for mutation endpoints.
name	string	required	The CMS entity item name.
status	string	optional	The BotStar CMS entity item status.
data	object	optional	Dynamic CMS item field values keyed by BotStar field unique name, excluding nam…

GET

bot_star_get_cms_entity_item

Get one item from a BotStar CMS entity.

/bots/{botId}/cms_entities/{entityId}/items/{entityItemId}

4 parameters

Param	Type	Required	Description
botId	string	required	The BotStar bot ID.
entityId	string	required	The BotStar CMS entity ID.
entityItemId	string	required	The BotStar CMS entity item ID.
env	string	optional	The BotStar environment to read or mutate.

PATCH

bot_star_update_cms_entity_item

Update an item in a BotStar CMS entity.

/bots/{botId}/cms_entities/{entityId}/items/{entityItemId}

7 parameters

Param	Type	Required	Description
botId	string	required	The BotStar bot ID.
entityId	string	required	The BotStar CMS entity ID.
entityItemId	string	required	The BotStar CMS entity item ID.
env	string	optional	The BotStar environment target for mutation endpoints.
name	string	optional	The updated CMS entity item name.
status	string	optional	The BotStar CMS entity item status.
data	object	optional	Dynamic CMS item field values keyed by BotStar field unique name, excluding nam…

DELETE

bot_star_delete_cms_entity_item

Delete an item from a BotStar CMS entity.

/bots/{botId}/cms_entities/{entityId}/items/{entityItemId}

4 parameters

Param	Type	Required	Description
botId	string	required	The BotStar bot ID.
entityId	string	required	The BotStar CMS entity ID.
entityItemId	string	required	The BotStar CMS entity item ID.
env	string	optional	The BotStar environment target for mutation endpoints.