Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-13161564.6 KB
Endpoints

Create a endpoint

post/v1/endpoint

Request body

slugstring required

The slug of the endpoint

namestring

The name of the endpoint

isEnabledboolean

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

emailNotificationsboolean

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

redirectUrlstring uri

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

targetEmailsstring[] required
icon'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'

The icon of the endpoint

color'gray' | 'amber' | 'red' | 'lime' | 'teal' | 'cyan' | 'indigo' | 'violet' | 'pink' | 'white'

The color the endpoint icon

Example request

{
  "slug": "my-endpoint",
  "name": "My Endpoint",
  "isEnabled": true,
  "redirectUrl": "https://example.com/thanks-you",
  "targetEmails": [
    "example1@formizee.com",
    "example2@formizee.com"
  ],
  "icon": "bolt",
  "color": "pink"
}

Response

Create a endpoint

idstring required

The id of the endpoint

workspaceIdstring required

The id of the workspace

slugstring required

The slug of the endpoint

namestring required

The name of the endpoint

isEnabledboolean

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

emailNotificationsboolean

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

redirectUrlstring uri

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

targetEmailsstring[] required
icon'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'

The icon of the endpoint

color'gray' | 'amber' | 'red' | 'lime' | 'teal' | 'cyan' | 'indigo' | 'violet' | 'pink' | 'white'

The color the endpoint icon

Example response

{
  "id": "enp_4VjHrJoEwAFC6itz8oUBW9NW2bia",
  "workspaceId": "ws_4VjHrJoEwAFC6itz8oUBW9NW2bia",
  "slug": "my-endpoint",
  "name": "My Endpoint",
  "isEnabled": true,
  "redirectUrl": "https://example.com/thanks-you",
  "targetEmails": [
    "example1@formizee.com",
    "example2@formizee.com"
  ],
  "icon": "bolt",
  "color": "pink"
}