v51

latestOpenAPI 3.0.1raw.githubusercontent.com2026-08-0118684573.2 KB
Form Assignments

Assigning an Actor to a Form Role

Given a roleId, which may be a numeric ID or a string role system name, and a numeric actorId, assigns that Role to that Actor for this particular Form.

No POST body data is required, and if provided it will be ignored.

post/v1/projects/{projectId}/forms/{xmlFormId}/assignments/{roleId}/{actorId}

Path parameters

projectIdnumber required

The numeric ID of the Project

xmlFormIdstring required

The xmlFormId of the Form being referenced.

roleIdstring required

Typically the integer ID of the Role. You may also supply the Role system name if it has one.

actorIdnumber required

The integer ID of the Actor.

Response

OK

successboolean required

Example response

{
  "success": true
}