Skip to main content

Creates a new campaign for the dealer for given department​

Newly created campaign will lie under the dealer's subaccount for passed department

Path Parameters
    dealerUUID string required
Request Body required
    messagingServiceSid string
    brandRegistrationSid string
    departmentType string
    useDefaultValuesForRegistration boolean
    description string
    messageFlow string
    messageSamples string[]
    appToPersonUseCase string
    embeddedLinks boolean
    embeddedPhone boolean
    optInMessage string
    optOutMessage string
    helpMessage string
    optInKeywords string[]
    optOutKeywords string[]
    helpKeywords string[]
    termsOfServiceUrl string
    privacyPolicyUrl string
    onlineSchedularUrl string
Responses

OK

Schema
    status string

    Possible values: [SUCCESS, FAILURE]

    errors object[]
  • Array [
    • errorCode string
    errorDescription string
    errorUID string
  • ]
    • warnings object[]
  • Array [
    • warningCode string
    warningDescription string
  • ]
    • sid string
    brand_registration_sid string
    messaging_service_sid string
    campaign_status string
    campaign_id string
POST /dealers/:dealerUUID/twilio/applicationToPerson/campaign

Authorization

name: basicAuthtype: httpscheme: basic

Request

Base URL
/communications
Username
Password
dealerUUID — path required
Body required
{

  "messagingServiceSid": "string",

  "brandRegistrationSid": "string",

  "departmentType": "string",

  "useDefaultValuesForRegistration": true,

  "description": "string",

  "messageFlow": "string",

  "messageSamples": [

    "string"

  ],

  "appToPersonUseCase": "string",

  "embeddedLinks": true,

  "embeddedPhone": true,

  "optInMessage": "string",

  "optOutMessage": "string",

  "helpMessage": "string",

  "optInKeywords": [

    "string"

  ],

  "optOutKeywords": [

    "string"

  ],

  "helpKeywords": [

    "string"

  ],

  "termsOfServiceUrl": "string",

  "privacyPolicyUrl": "string",

  "onlineSchedularUrl": "string"

}
curl / cURL
curl -L -X POST '/communications/dealers/:dealerUUID/twilio/applicationToPerson/campaign' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "messagingServiceSid": "string",
  "brandRegistrationSid": "string",
  "departmentType": "string",
  "useDefaultValuesForRegistration": true,
  "description": "string",
  "messageFlow": "string",
  "messageSamples": [
    "string"
  ],
  "appToPersonUseCase": "string",
  "embeddedLinks": true,
  "embeddedPhone": true,
  "optInMessage": "string",
  "optOutMessage": "string",
  "helpMessage": "string",
  "optInKeywords": [
    "string"
  ],
  "optOutKeywords": [
    "string"
  ],
  "helpKeywords": [
    "string"
  ],
  "termsOfServiceUrl": "string",
  "privacyPolicyUrl": "string",
  "onlineSchedularUrl": "string"
}'