Skip to main content
POST
/
v1
/
registrations
/
register-email
Create an email registration
curl --request POST \
  --url https://api.oneofnone.io/v1/registrations/register-email \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "email": "jsmith@example.com",
  "collection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "short_url": "<string>",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "metadata": {}
}
'
{
  "success": true,
  "email": "jsmith@example.com",
  "registration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "token_id": 123,
  "registration_settings": {}
}

Authorizations

​
x-api-key
string
header
required

The API key required for accessing protected routes. It should be included in the request headers as x-api-key.

Body

application/json
​
email
string<email>
required

The email address of the registrant.

​
collection_id
string<uuid>
required

The unique identifier of the collection.

​
short_url
string
required

The short URL identifier for the product being registered.

​
user_id
string<uuid>

Optional user ID to associate with the registration.

​
metadata
object

Additional metadata to store with the registration.

Response

Successfully created registration.

​
success
boolean
Example:

true

​
email
string<email>
​
registration_id
string<uuid>
​
token_id
integer
​
registration_settings
object