Create signup

POST 
/signups

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

Request

application/json

Body

email_address stringrequired

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

All 'campaign[]' params are mutually exclusive, only one can be provided.

id string

name string

source string

medium string

term string

content string

Responses

200

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

application/json

Schema

Schema

id stringrequired

The ID of the signup

email_address stringrequired

The e-mail address that was sent the welcome email

Example (from schema)

{
  "id": "string",
  "email_address": "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
  }
}

Loading...