Skip to content

The Sliick Forms REST API

This page is a developer reference for anyone who needs to know how Sliick Edge talks to your org, or who creates record links from Apex or Flow. Admins setting up a form or a public site do not need it: see Choosing how to host a form instead.

Sliick Forms has four Apex REST routes: fetch a form’s manifest, submit a response, upload a file, and create a save-and-continue token. Sliick Edge calls them when it serves your forms on your Sliick Edge address, signed in to your org as an integration user you set up.

They are not for guest users, and no packaged permission set grants them to a guest. The server cannot tell a browser from a script, and Origin and Referer are set by the caller, so granting these routes to a site’s guest user would open submit, upload and resume to the whole internet. On an Experience Cloud page, use the Sliick Experience Form component instead, which uses Salesforce’s own session-protected connection.

The package includes an External Client App called Sliick Forms Integration, registered when you install. Sliick Edge signs in through it with the JWT Bearer flow. The flow and its certificate come with the package and cannot be changed in your org, and Sliick holds the private key, so there is no consumer key, secret, callback URL or certificate to enter. It does not work until an admin edits its Policies screen, which is the usual reason a first connect fails.

  1. Create a dedicated integration user on the Minimum Access - Salesforce profile. Never use a person’s user.
  2. Assign the packaged Sliick Forms Integration permission set to that user. Do not clone it: upgrades update the packaged set, never your copy. The set grants access to the four routes and the callback route, read-only access to form definitions, elements and the form log, and Create on the two submission platform events. It grants no Form_Submission__c access at all. It does not give the user API Enabled: a packaged permission set cannot deliver that on install. Grant it yourself, through a permission set you created or the user’s profile. The Minimum Access - API Only Integrations profile already has it. Without it, every call is refused.
  3. Setup, External Client App Manager, Sliick Forms Integration, Policies, Edit. Set Permitted Users to Admin approved users are pre-authorized and pre-authorise the integration user’s own profile, or a permission set you created yourself and assigned to that user. A packaged permission set such as Sliick Forms Integration cannot be used: Salesforce says a permission set from a managed package cannot be added to an External Client App. That is the whole screen: there is no flow to turn on.
  4. Connect from the Admin Dashboard, naming the user from step 1 as the integration username. Sliick Edge signs in as that user from then on. See Sliick Edge for the full steps.

Revoking access is one step: unassign the permission set from the user, or deactivate the user. Both take effect on the next call.

All use the sliick namespace and all need an Authorization: Bearer <token> header.

MethodRoutePurpose
GET or POST/services/apexrest/sliick/experience/*Fetch a form’s manifest bundle
POST/services/apexrest/sliick/submitSubmit a response
POST/services/apexrest/sliick/uploadSecure file intake
POST/services/apexrest/sliick/resumeCreate a save-and-continue token

You can pass formExternalId in the path, as a query parameter, or in a POST body.

A fifth route, POST /services/apexrest/sliick/callback, is only for Sliick Edge to deliver its connection credentials to your org. It refuses anything that is not a correctly signed delivery for that org. You never call it.

/upload takes formExternalId, fileName and base64, and answers 201 with {"success": true, "uploadRef": "…", "fileName": "…", "errors": []}. Put the uploadRef in the submission payload for that field.

/resume takes formExternalId and state, where state is {"values": {…}, "rows": {…}, "page": 0}, and answers 201 with {"success": true, "resumeRef": "<token>"}.

Creating a record link is not one of the REST routes. It is an Apex call in your org that runs as the calling user, so it prefills only what that user can already read on the record:

String response = sliick.FormsApi.invoke('createRecordLink',
    '{"params":{"formExternalId":"intake","recordId":"a0X...",'
        + '"valueOverrides":{"email":"a@b.com","seats":2}}}');

On success:

{ "url": "https://forms.example.com/intake?sliickPrefill=<token>",
  "token": "<token>", "expiresAt": "2026-09-19T09:00:00.000Z",
  "formExternalId": "intake", "recordId": "a0X..." }

recordId takes 15 or 18 characters; both key the same link. valueOverrides is optional: a JSON object of element API name to value, where each value is a string, a number, true/false, or a list of strings. A value replaces what the record would supply, or adds an element the record does not map. Omit it for the fully automatic record-derived map.

Plan around three rules:

  • A link expires after 7 days. This cannot be changed.
  • A link is used up on submit. From 1.2, a later submission through it is refused with 403 and Record_Link_Used, and a link that was replaced or has expired is refused with 403 and Record_Link_Invalid. Saving partway does not use up the link.
  • There is one live link per form per record for the whole org. Calling this again replaces the link: the previous one stops working immediately, along with any answers saved behind it.

Refusals come back as success: false with a code and a more specific result.reason. Branch on the reason, never on the message text:

result.reasonMeaning
FORM_NOT_FOUNDNo such form, or not visible to you
FORM_NOT_OPENPaused, outside its schedule, or at its cap
NOTHING_TO_PREFILLNo element maps to a field you can read on that record
NO_DELIVERY_ADDRESSThe org has no public address for this form. Nothing was written
INVALID_RECORD_IDNot a valid Id
INSUFFICIENT_ACCESSAssign Sliick_Forms_Operator or Sliick_Forms_Admin
UNKNOWN_FIELDA valueOverrides key names no element on this form, or one that cannot take a value
MATCH_FIELD_LOCKEDA valueOverrides key names the form’s matching element, which cannot be overridden
INVALID_REQUESTvalueOverrides could not be read, or the form’s external id is too long to key a link
WRITE_FAILEDThe org refused the write: a validation rule or a trigger

From Flow, use the action Create Sliick Form Record Link, in the Sliick Forms category.

  • Inputs: Form External ID (formExternalId), Record ID (recordId) and the optional Value Overrides (JSON) (valueOverridesJson). Build the JSON in a Text Template set to Plain text, because rich text encodes the quotes.
  • Outputs: Success, URL, Expires At, Error Code and Error Message (success, url, expiresAt, errorCode, errorMessage), one result per input, in the same order.

The action never fails the Flow: one refused record does not stop the rest. If you send too many records in one go, they come back with BATCH_TOO_LARGE. Ten to twenty per Flow interview is comfortable.

An older package ignores valueOverrides instead of refusing it, and listOperations cannot tell you which version you have. Check the installed package version in Setup, Installed Packages, or with sf package installed list.

/submit, /upload and /resume refuse an unsigned request with 401 and Missing X-Sliick-Signature header when the form they name is served on your Sliick Edge address, meaning Allow on your public Sliick Edge address is ticked on that form.

  • The rule is per form, not per org. A form that is not on your edge address is unaffected, even in an org that uses the edge for other forms.
  • Sliick Edge signs each of these requests with a secret your org holds but no one can read. That is also where rate limiting and bot filtering run before a request reaches your org.
  • Unaffected: forms not on your edge address, orgs with no edge connection, Experience Cloud forms, and /experience, which has never verified signatures.
  • A signature you do send is always checked, whatever the form’s setting. A correctly signed request for a form that is not on your Sliick Edge address is refused with 403 and Edge_Not_Enabled.
  • From 1.2, the signature names the route it was sent to. A signed request is refused unless it carries the signature for that route, so a captured request cannot be replayed against a different route. Sliick Edge sends it for you. Requests with no signature are treated as before.

Add "keepIfInvalid": true (a JSON boolean) to a /submit request and a response that fails the form’s validation is stored instead of refused. You get 202 with the status Stored_For_Review, the messages in errors, and no submissionId. The response shows a Failed validation badge in Sliick Responses. It is not processed, and its webhook is held, until an admin accepts it. See The responses console. Without the key, a failing response is refused with 400 Validation_Failed as before.

  • Upload budget. By default, a form accepts up to 250 MB from each calling user in any 24 hours over /upload. Past that you get 429 with Upload_Budget_Exceeded and a Retry-After header. See File uploads.
  • Requests turned away are recorded and shown on the dashboard. See The Admin Dashboard.
  • Repeated link ids. A /submit under a link id already used on that form, with different answers, is stored and flagged Suspected duplicate. An exact repeat is recorded once.
  • Identities you granted Create on Form Submission also need Read on the Suspected Duplicate and Answers Digest fields, and Read on Failed Validation and Validation Errors if they process responses. Without the first pair, a submission is still recorded, but the answer is 202 Accepted with no submissionId.

Flow actions over REST. Sliick Forms Admin and Sliick Forms Operator can call the record-link and process Flow actions through the REST API. You still need to grant Salesforce’s Run Flows permission. The action labelled Sliick: Deprecated - do not use (formerly Trigger Secure Upload Link) does nothing: do not use it.

CodeMeaning
200Manifest served
201 ReceivedSubmission stored straight away. The body includes submissionId
202 AcceptedSubmission queued for processing. No submissionId: track it by your own correlationId
202 Stored_For_ReviewSent with keepIfInvalid: true and failed validation. Stored, not processed until an admin accepts it. errors lists the messages. No submissionId
400Invalid_Request or Validation_Failed. The errors array names the failing fields
401Signature_Invalid, or a required signature was missing
429Upload_Budget_Exceeded: the form’s daily upload budget is spent. Wait for Retry-After
403Form_Closed, Edge_Not_Enabled (a signed request for a form not on your Sliick Edge address), Record_Link_Used (a record link already used to submit) or Record_Link_Invalid (a record link that was replaced or has expired). If the whole route returns 403 with no JSON body, the caller lacks access to that route
404Form_Not_Found: no visible definition with that external ID
500Server fault, or Validation_Unavailable where the server could not load the form’s elements to validate against. Retry with backoff rather than treating it as a rejection of the payload

Your caller’s permissions decide which you get, not a parameter. A caller with Create on Form_Submission__c gets 201 with an ID. A caller without it, which includes every packaged permission set, gets 202. Treat 202 as the normal success case and do not depend on getting a submissionId.

A refusal means something different at each stage. Work down this list:

  1. The sign-in is refused. Sliick Forms has not been called yet. Almost always the Permitted Users setting, or an integration user whose profile or permission set was never pre-authorised. Check the profile the integration user actually has. A missing API Enabled also fails here.
  2. The whole route returns 403 with no Sliick Forms JSON body. The integration user does not have access to that route. Assign the packaged Sliick Forms Integration set, not a clone of it.
  3. A 403 carrying {"status": "Form_Closed"}. The sign-in worked. The form is paused, outside its schedule window, or at its response cap.
  4. A 404 on /experience for a form you can see in the builder. The form does not have Allow on your public Sliick Edge address ticked, so Sliick Edge is not allowed to serve it.