What the Ayeform API does and where to start.
Create a workspace API key and send it with every request.
Set your key and list your forms in two commands.
Every error answers with a status, a stable code and a message.
Lists that can grow without limit come back one page at a time, and you follow a cursor to the next page.
A response is saved while the person answers, so every response is finished, started or left.
Every response says whether the person agreed to be called and texted, when, to which wording, and for which number.
Responses are kept forever. A plan shows a number of days of them, and older ones are hidden until a plan shows them again.
A workspace member can be limited to some brands. They, and the API keys they make, see only those brands.
Files people upload with a form stay private. You read them with your API key, which gives you a short-lived download link.
A few endpoints act on the workspace itself or on money. Some need the workspace owner, and some only work from the app, never with an API key.
Some form features need the plan to include them. You need the plan to turn one on, but whatever is already on stays on.
Each new response is POSTed to a brand's or form's webhooks as signed JSON, with retries.
Exports turn a form's responses into spreadsheet rows. Every way to export uses the same columns.
Workspaces
/v1/workspaces/{workspaceId}Give the workspace a new name. Any member can.
workspaceIdstringrequiredThe workspace's id. An API key can only use its own workspace.
JSON, with Content-Type: application/json.
namestringrequiredThe new name.
1–100 chars
200 with a JSON body.
Errors answer with a status and the error shape.