Skip to main content

Post Customers via the API

There are two methods to post a customer record to Volie and enroll them into a campaign. We recommend method #2, because you will get back the customer communication manager details.

S
Written by Sadie Timmons
Updated over 3 months ago

Method #1: Lead Post Endpoint

To simultaneously create a customer and enroll them into a designated campaign, use the lead-post endpoint. Here is a link to the API docs which specifically address the lead post: https://app.volie.io/docs/api#lead-post

The customer is required to have a first name and/or last name as well as AT LEAST one contact method: at least one phone number (cell_phone, home_phone, work_phone) OR a valid email address OR a full address.

Note: If you want to send SMS to the customer, a phone number is required. Similarly, if you wish to send the customer an email, you will need an email address.

The campaign_key differs by the campaign itself, so we will need to provide the actual campaign keys once we are ready to launch. For now, we’ve created a test campaign that you can use to send test posts.

Method #2: Match/Create Customer + Enroll Campaign Customer Endpoints

Step 1: Post customer record into Volie - Based on the parameters that you provide; we will attempt by match those details to one of your existing customers. If we find a match, then we will return the customer. When no match is found, we will create a new customer and return it. The customer is required to have a first name and/or last name as well as AT LEAST one contact method: at least one phone number (cell_phone, home_phone, work_phone) OR a valid email address OR a full address.

POST to “match_or_create_customer”. Here is a link to the API docs which specifically address the match or create customer endpoint: https://app.volie.com/docs/api#match-or-create-customer

On success, returns a “customer_key”.

Step 2: Enroll customer into email campaign via “Enroll Campaign Customer” endpoint. This will enroll the customer into the campaign immediately.

POST to “enroll_campaign_customer”. Here is a link to the API docs which specifically address the enroll campaign customer endpoint: https://app.volie.com/docs/api#enroll-campaign-customer

Request params to post us:

campaign_key = “XXXX-….”

customer_key = “XXXX-…….”

The campaign_key differs by the campaign itself.

Did this answer your question?