Campaign Conversations

Initiate outbound conversation from inbox

Send an approved template to a campaign target and create a new conversation. The target must already exist in the campaign. Returns 409 if an active conversation already exists for this target — close it first before initiating.

post/api/v1/campaigns/{campaignId}/conversations/initiate

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/api/v1/campaigns/{campaignId}/conversations/initiate
  • Auth: bearerAuth (a scheme the document does not define)

Path parameters

campaignIdstring uuid required

Campaign UUID

Request body

targetIdstring uuid required
phoneNumberIdstring uuid required
provider'ainumber' | 'meta' | 'kapso' | '2chat' required
languagestring
tagsobject
buttonTagsobject
headerMediastring uri

Response

Created

successtrue required
messagestring

Changes

No recorded changes to this operation across all 1 revision of this API.