Bird

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

API key12 toolshttps://api.bird.com

GET

bird_list_channels

List channels configured for a Bird workspace with optional filters.

/workspaces/{workspaceId}/channels

13 parameters

Param	Type	Required	Description
workspaceId	string	required	The Bird workspace ID.
limit	integer	optional	The maximum number of channels to return.
pageToken	string	optional	The pagination token returned by a previous request.
reverse	boolean	optional	Whether to reverse the order in which channels are returned.
platform	string	optional	Filter channels by platform name.
conferencial	boolean	optional	Filter channels by Bird's conferencial flag.
onlyMyChannels	boolean	optional	Only return channels the authenticated principal can access.
useCaseType	string	optional	Filter channels by the Bird use case type.
channelIds	array	optional	Filter channels by channel IDs.
resourceOwnerIds	array	optional	Filter channels by resource owner IDs.
resourceOwnerIdentifiers	array	optional	Filter channels by resource owner identifiers.
suite	string	optional	Filter channels by the Bird suite.
platformStatus	string	optional	Filter channels by platform release status.

GET

bird_get_channel

Retrieve a specific Bird workspace channel by ID.

/workspaces/{workspaceId}/channels/{channelId}

2 parameters

Param	Type	Required	Description
workspaceId	string	required	The Bird workspace ID.
channelId	string	required	The Bird channel ID.

GET

bird_get_message

Retrieve a Bird channel message by ID.

/workspaces/{workspaceId}/channels/{channelId}/messages/{messageId}

3 parameters

Param	Type	Required	Description
workspaceId	string	required	The Bird workspace ID.
channelId	string	required	The Bird channel ID.
messageId	string	required	The Bird channel message ID.

GET

bird_list_message_interactions

List interactions recorded for a Bird channel message.

/workspaces/{workspaceId}/channels/{channelId}/messages/{messageId}/interactions

3 parameters

Param	Type	Required	Description
workspaceId	string	required	The Bird workspace ID.
channelId	string	required	The Bird channel ID.
messageId	string	required	The Bird channel message ID.

POST

bird_send_message

Send one message through a Bird workspace channel.

/workspaces/{workspaceId}/channels/{channelId}/messages

3 parameters

Param	Type	Required	Description
workspaceId	string	required	The Bird workspace ID.
channelId	string	required	The Bird channel ID.
message	object	optional	A Bird channel message request. Provide either body or template.

POST

bird_send_batch_messages

Send a batch of up to 100 messages through a Bird workspace channel and return the accepted batch IDs.

/workspaces/{workspaceId}/channels/{channelId}/batch/messages

3 parameters

Param	Type	Required	Description
workspaceId	string	required	The Bird workspace ID.
channelId	string	required	The Bird channel ID.
messages	array	optional	The Bird channel messages to send.

GET

bird_list_contacts

List contacts in a Bird workspace.

/workspaces/{workspaceId}/contacts

1 parameter

Param	Type	Required	Description
workspaceId	string	required	The Bird workspace ID.

GET

bird_get_contact

Retrieve a Bird contact by ID, optionally requesting specific attributes.

/workspaces/{workspaceId}/contacts/{contactId}

3 parameters

Param	Type	Required	Description
workspaceId	string	required	The Bird workspace ID.
contactId	string	required	The Bird contact ID.
attribute	string	optional	A contact attribute name to include in the response.

POST

bird_search_contact_by_identifier

Search Bird contacts by an identifier key and value.

/workspaces/{workspaceId}/contacts/search

2 parameters

Param	Type	Required	Description
workspaceId	string	required	The Bird workspace ID.
identifier	object	optional	A Bird contact identifier.

POST

bird_create_contact

Create a Bird contact with identifiers, attributes, display name, or list IDs.

/workspaces/{workspaceId}/contacts

2 parameters

Param	Type	Required	Description
workspaceId	string	required	The Bird workspace ID.
contact	object	optional	The Bird contact fields to create.

PATCH

bird_update_contact

Update a Bird contact's identifiers, attributes, or list memberships.

/workspaces/{workspaceId}/contacts/{contactId}

3 parameters

Param	Type	Required	Description
workspaceId	string	required	The Bird workspace ID.
contactId	string	required	The Bird contact ID.
patch	object	optional	The Bird contact update fields.

DELETE

bird_delete_contact

Delete a Bird contact by ID.

/workspaces/{workspaceId}/contacts/{contactId}

2 parameters

Param	Type	Required	Description
workspaceId	string	required	The Bird workspace ID.
contactId	string	required	The Bird contact ID.