Create signup
POSThttps://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
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
The e-mail address that should receive the welcome e-mail
The code for the coupon that will be applied to the first new organization created by the user
campaign
object
Responses
- 200
- 403
- 404
- 422
- 429
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
- Example (from schema)
Schema
The ID of the signup
The e-mail address that was sent the welcome email
The URL for the user to continue their signup process, only available if verify_with_email is false
{
"id": "string",
"email_address": "string",
"url": "string"
}
403 error response
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [internal_auth_error
]
detail
object
{
"code": "internal_auth_error",
"description": "string",
"detail": {
"details": "string"
}
}
The provided coupon code is not valid
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [invalid_coupon_code
]
detail
object
{
"code": "invalid_coupon_code",
"description": "string",
"detail": {
"code": "string"
}
}
A validation error occurred with the object that was being created/updated/deleted
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [validation_error
]
detail
ValidationError
{
"code": "validation_error",
"description": "string",
"detail": {
"errors": [
"string"
]
}
}
You have reached the rate limit for this type of request
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [rate_limit_reached
]
detail
object
{
"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"
}
}'