Skip to main content
POST
/
v1
/
endpoint
Create a endpoint
curl --request POST \
  --url https://api.formizee.com/v1/endpoint \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "slug": "my-endpoint",
  "name": "My Endpoint",
  "isEnabled": true,
  "emailNotifications": false,
  "redirectUrl": "https://example.com/thanks-you",
  "targetEmails": [
    "[email protected]",
    "[email protected]"
  ],
  "icon": "bolt",
  "color": "pink"
}'
{
  "id": "enp_4VjHrJoEwAFC6itz8oUBW9NW2bia",
  "workspaceId": "ws_4VjHrJoEwAFC6itz8oUBW9NW2bia",
  "slug": "my-endpoint",
  "name": "My Endpoint",
  "isEnabled": true,
  "emailNotifications": false,
  "redirectUrl": "https://example.com/thanks-you",
  "targetEmails": [
    "[email protected]",
    "[email protected]"
  ],
  "icon": "bolt",
  "color": "pink"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
slug
string
required

The slug of the endpoint

Required string length: 4 - 64
Example:

"my-endpoint"

​
targetEmails
string<email>[]
required
​
name
string

The name of the endpoint

Required string length: 4 - 64
Example:

"My Endpoint"

​
isEnabled
boolean
default:true

The state of the endpoint. If is false, the endpoint don't receive more submissions

Example:

true

​
emailNotifications
boolean
default:true

The state of the email notifications. If is true, the endpoint will send a notification for each submission created

Example:

false

​
redirectUrl
string<uri>
default:https://formizee.com/thanks-you

The redirect url of the endpoint. When a user send a submission through a form, will be redirected to this url.

Example:

"https://example.com/thanks-you"

​
icon
enum<string>
default:file

The icon of the endpoint

Available options:
file,
file-chart,
start,
bookmark,
heart,
flag,
bolt,
bell,
lightbulb,
credit-card,
stack,
cube,
database,
server,
inbox,
calendar,
mail,
checkcircle,
book,
chat,
user-group,
console,
tools,
grid,
moon,
sun,
cloud,
cart,
gift,
music,
beaker,
video,
code,
maps,
face-smile,
face-frown,
paint,
bug,
school,
rocket
Example:

"bolt"

​
color
enum<string>
default:gray

The color the endpoint icon

Available options:
gray,
amber,
red,
lime,
teal,
cyan,
indigo,
violet,
pink,
white
Example:

"pink"

Response

Create a endpoint

​
id
string
required

The id of the endpoint

Example:

"enp_4VjHrJoEwAFC6itz8oUBW9NW2bia"

​
workspaceId
string
required

The id of the workspace

Example:

"ws_4VjHrJoEwAFC6itz8oUBW9NW2bia"

​
slug
string
required

The slug of the endpoint

Required string length: 4 - 64
Example:

"my-endpoint"

​
name
string
required

The name of the endpoint

Required string length: 4 - 64
Example:

"My Endpoint"

​
targetEmails
string<email>[]
required
​
isEnabled
boolean
default:true

The state of the endpoint. If is false, the endpoint don't receive more submissions

Example:

true

​
emailNotifications
boolean
default:true

The state of the email notifications. If is true, the endpoint will send a notification for each submission created

Example:

false

​
redirectUrl
string<uri>
default:https://formizee.com/thanks-you

The redirect url of the endpoint. When a user send a submission through a form, will be redirected to this url.

Example:

"https://example.com/thanks-you"

​
icon
enum<string>
default:file

The icon of the endpoint

Available options:
file,
file-chart,
start,
bookmark,
heart,
flag,
bolt,
bell,
lightbulb,
credit-card,
stack,
cube,
database,
server,
inbox,
calendar,
mail,
checkcircle,
book,
chat,
user-group,
console,
tools,
grid,
moon,
sun,
cloud,
cart,
gift,
music,
beaker,
video,
code,
maps,
face-smile,
face-frown,
paint,
bug,
school,
rocket
Example:

"bolt"

​
color
enum<string>
default:gray

The color the endpoint icon

Available options:
gray,
amber,
red,
lime,
teal,
cyan,
indigo,
violet,
pink,
white
Example:

"pink"