Trialmile docs

Create

POST
/dev/consumers/create

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

campaignId*string
Length1 <= length
count*integer
Range1 <= value <= 500
phonePattern?string
Length3 <= length <= 24
addressSource*string

Value in

  • "in_zone"
  • "out_of_zone"
  • "fixture"
  • "garbage"
  • "messy"
zoneId?string
Length1 <= length
productChoice*string

Value in

  • "first"
  • "random"
  • "invalid_then_valid"
optOutRate?number
Range0 <= value <= 1
seed?integer
Range0 <= value <= 9007199254740991

Response Body

application/json

curl -X POST "https://example.com/dev/consumers/create" \  -H "Content-Type: application/json" \  -d '{    "campaignId": "string",    "count": 1,    "addressSource": "in_zone",    "productChoice": "first"  }'
null