Create a Chat Conversation
Create a Chat Conversation in Funnel for a Chat Conversation created by a partner
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”The Community ID, this will look like either ‘1234’ or ‘P1234-567’. Alternatively, if you prefix this value with
partner-id:, for example partner-id:apts123 you can use your own community, as long as you have previously provided that
ID to Funnel.
Examples
Funnel Community ID
The raw integer Funnel ID of a community.
1234Funnel Community Syndication ID
The community’s Funnel syndcation ID. An ID in this format is often provided in Funnel feeds to ILS partners.
P1234-567Partner ID
The ID of the community in the partner system. This needs to have been previously provided to Funnel and setup.
partner-id:apts123Request Body
Section titled “Request Body ”object
Funnel Renter ID
123Obtain appropriate value from Funnel
URL where the covnersation happened
http://example.comHas the conversation finished
trueobject
Who wrote the message
The content of the message
hiDatetime of when the message was created
2023-10-04T00:02:23Responses
Section titled “ Responses ”Chat Conversation created succesfully.
We were unable to authenticate your request with the provided API key.
object
CommunityNotFoundCould not find community with corresponding ID.A community with this ID does not exist.
object
CommunityNotFoundCould not find community with corresponding ID.