Create signup

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

This will create a new signup object, which can be either verified by e-mail or by the user creating an account in Identity

Request

application/json

Body

verify_with_email boolean

If true, the user will be sent an email to verify their e-mail address, and if false, the user will need to verify their e-mail address when they create an account in Identity

email_address string

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

coupon string

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

campaign

object

id string

name string

source string

medium string

term string

content string

Responses

200

This will create a new signup object, which can be either verified by e-mail or by the user creating an account in Identity

application/json

Schema

Schema

id stringrequired

The ID of the signup

email_address stringnullablerequired

The e-mail address that was sent the welcome email

url stringnullablerequired

The URL for the user to continue their signup process, only available if verify_with_email is false

Example (from schema)

{
  "id": "string",
  "email_address": "string",
  "url": "string"
}

403

403 error response

application/json

Schema

Schema

code InternalAuthErrorEnum (string)

Possible values: [internal_auth_error]

description string

detail

object

details string

Example (from schema)

{
  "code": "internal_auth_error",
  "description": "string",
  "detail": {
    "details": "string"
  }
}

404

The provided coupon code is not valid

application/json

Schema

Schema

code InvalidCouponCodeEnum (string)

Possible values: [invalid_coupon_code]

description string

detail

object

code string

Example (from schema)

{
  "code": "invalid_coupon_code",
  "description": "string",
  "detail": {
    "code": "string"
  }
}

422

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

application/json

Schema

Schema

code ValidationErrorEnum (string)

Possible values: [validation_error]

description string

detail

ValidationError

errors string[]

Example (from schema)

{
  "code": "validation_error",
  "description": "string",
  "detail": {
    "errors": [
      "string"
    ]
  }
}

429

You have reached the rate limit for this type of request

application/json

Schema

Schema

code RateLimitReachedEnum (string)

Possible values: [rate_limit_reached]

description string

detail

object

total_permitted integer

The total number of requests per minute that are permitted

Example (from schema)

{
  "code": "rate_limit_reached",
  "description": "string",
  "detail": {
    "total_permitted": 0
  }
}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L 'https://api.katapult.io/public/v1/signups' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
  "verify_with_email": true,
  "email_address": "string",
  "coupon": "string",
  "campaign": {
    "id": "string",
    "name": "string",
    "source": "string",
    "medium": "string",
    "term": "string",
    "content": "string"
  }
}'

Request Collapse all

Base URL

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

Body

{
  "verify_with_email": true,
  "email_address": "string",
  "coupon": "string",
  "campaign": {
    "id": "string",
    "name": "string",
    "source": "string",
    "medium": "string",
    "term": "string",
    "content": "string"
  }
}

ResponseClear

Click the Send API Request button above and see the response here!