New proactive journey
POST {{connect_base_url}}/v1/proactive_journey
In addition to the basic customer object and other contextual data, you must supply:
first_collection_datefirst_collection_amount_cents
These values represent the date and amount the first deduction will be made so that the customer can be made aware of an upcoming deduction.
Depending on your campaign setup, or to provide additional useful information for segmentation or messaging, you may also supply additional_attributes. You are free to name these and provide a suitable data type.
Request Body
{"customer"=>{"first_name"=>"Postman", "last_name"=>"Test", "email_address"=>"postman@test.com", "phone_number"=>"+27-781317144", "identifications"=>[{"type"=>"IDENTITY_DOCUMENT", "details"=>"2001014800086"}], "title"=>"Mr.", "alpha2_country_code"=>"ZA", "ietf_language_code"=>"en", "allow_email"=>true, "allow_sms"=>true, "allow_whatsapp"=>true, "utc_offset"=>2, "preferred_currency_code"=>"ZAR"}, "product"=>{"reference"=>"PS1234", "inception_date"=>"2023-08-23T10:07:19.534Z", "name"=>"Postman Subscription", "currency"=>"ZAR"}, "brand_name"=>"Revio", "merchant_name"=>"{{merchant_name}}", "recurring_frequency"=>"Monthly", "recurring_amount_cents"=>1, "whatsapp_opt_in"=>true, "test_user"=>true, "unsubscribed"=>true, "first_collection_date"=>"2025-08-23T10:07:19.534Z", "first_collection_amount_cents"=>2, "additional_attributes"=>{"additionalProp1"=>"string"}}