Guests

Claim a guest's forms

POST/v1/guests/claim

After signing up or in, keep what you made as a guest. This moves the guest's forms, with the same ids, and their brand into the workspace. Calling it again after it worked returns the same result. It fails with 403 brand_limit when the workspace can't take another brand and no brandId was given, with 403 form_limit when the plan can't take the forms, and with 401 guest_expired for a token that is expired, forged or claimed by someone else. Only works from the app, not with an API key. See Owner-only and app-only.

curl -X POST "$AYEFORM_API/v1/guests/claim" \
  -H "Authorization: Bearer $AYEFORM_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "token": "…",
    "workspaceId": "WORKSPACE_ID"
  }'

200 Response

{
  "workspaceId": "q9vxefwe62t8njyxv1pjr1vdq9s1awap",
  "formIds": [
    "v7wskeddca2z4gmve1gy0vfpx75gt60p"
  ]
}

Body

JSON, with Content-Type: application/json.

tokenstringrequired
The guest token that POST /guest gave.
1–4096 chars
workspaceIdstringrequired
The workspace to move the forms into.
brandIdstring
One of the workspace's brands. The forms go under it, and the guest's own brand is dropped.

Response

workspaceIdstringrequired
The workspace the forms moved into.
formIdsarray of stringrequired
The forms that moved. They keep their ids.

Errors answer with a status and the error shape.