API Reference

Katapult Public API

Resources & Endpoints

Create signup

This will create a new signup object and e-mail the appropriate welcome e-mail to the given email address.

POST
https://api.katapult.io/public/v1/signups

If successful, this endpoint will return a 200 OK status.

Arguments

The following arguments are supported for this endpoint.

Name Type Default Value

email_address Required

The e-mail address that should receive the welcome e-mail

 String None

coupon

The code for the coupon that will be applied to the first new organization created by the user

 String None

campaign

SignupCampaignArguments None

Potential Errors

The following errors may occur during this request.

Details HTTP status

invalid_coupon_code

The provided coupon code is not valid

 404 Not Found

validation_error

A validation error occurred with the object that was being created/updated/deleted

 422 Unprocessable Entity

Returned Object

When the request is successful, you can expect an object matching the specification below to be returned.

{
    id: String
    email_address: String
}