REST API Customer Endpoints

Convert Customer

This endpoint will convert the latest session for a customer based off an email address.

POST /customer/convert/

Payload Structure:

Cart Data Payload Structure:

Any additional params will be treated as strings and added to the metadata field of the cart.

Cart Item Payload Structure:

Any additional params will be treated as strings and added to the metadata field of the cart item.

Example Payload:

{
  "email": "[email protected]",
  "cart_data": {
    "cart_value": 2000,
    "cart_item_count": 3,
    "promo": "SALE",
    "return_url": "http://example.com/cart/12345/"
  },
  "cart_items": [
    {
      "product_id": "12345",
      "name": "Product #1",
      "price": 1000,
      "description": "A product",
      "category": ["cool", "products"],
      "item_qty": 1,
      "qty_price": 1000,
      "product_url": "http://example.com/products/12345",
      "image_url": "http://example.com/products/img/12345.jpg"
    },
    {
      "product_id": "54321",
      "name": "Product #2",
      "price": 500,
      "description": "Another product",
      "category": ["awesome", "products"],
      "item_qty": 2,
      "qty_price": 1000,
      "product_url": "http://example.com/products/54321",
      "image_url": "http://example.com/products/img/54321.jpg"
    }
  ]
}

Journey Cancellation

This endpoint will immediately stop any active journeys for a specific customer.

POST /customer/cancel/

Payload Structure:

Example Payload:

{"email": "[email protected]"}

Customer Unsubscribe

This endpoint will unsubscribe a customer from receiving emails from Rejoiner.

POST /customer/unsubscribe/

Payload Structure:

Example Payload:

{"email": "[email protected]"}

Record Explicit Customer Consent

This endpoint will record the explicit consent of a customer in Rejoiner.

POST /customer/opt_in/

Payload Structure:

Any additional fields will be treated as strings and stored along with the record of explicit consent. This will allow you to store any additional information you find necessary regarding how the consent was received.

Example Payload:

{
  "email": "[email protected]",
  "type": "accepts marketing checkbox",
  "otherInfo": "accepted marketing on checkout page"
}

Get Customer Profile

This endpoint will return the customer profile data stored in Rejoiner. You can use either the Rejoiner Customer ID or the customer's email address.

GET /customers/CUSTOMER_ID/

GET /customers/EMAIL/

Example Response:

{
    "id": "foobar",
    "email": "[email protected]",
    "first_name": "Madonna",
    "last_name": "Lewis",
    "phone": "",
    "timezone": "",
    "age": 49,
    "gender": "",
    "language": "",
    "address1": "1505 Dogwood Lane",
    "address2": "",
    "address3": "",
    "city": "Tucson",
    "state": "AZ",
    "postal_code": "85705",
    "country": "US",
    "birthdate":"1969-10-26",
    "tags": [
      "foo",
      "bar"
    ],
    "is_unsubscribed": false,
    "unsubscribe_date": null,
    "is_opted_in": true,
    "opt_in_date":"2018-05-25T05:35:31.803626",
    "opt_in_info":{},
    "metadata": {
        "foo": "bar"
    }
}

Create Customer Profile

This endpoint will create the customer profile record.

POST /customers/

Payload Structure:

Update Customer Profile

This endpoint will update the customer profile record. You can use either the Rejoiner Customer ID or the customer's email address.

PUT /customers/CUSTOMER_ID/

PUT /customers/EMAIL/

Payload Structure:

The metadata field will accept a JSON object, but individual keys cannot later be updated separately. When updating metadata any previously existing metadata will be replaced.