Update Workflow

This endpoint allows you to add and remove users from a workflow and allows you to change the workflow name.

Information Circle

User Management: This endpoint is primarily used for managing workflow access permissions and updating basic workflow settings like the name.

POST Parameters

ParameterRequiredValueDescription
api_key{key}An API key that has access to the resource you want to query for
workflow_id{integer}The ID of a specific workflow
user_ids{integer}The IDs of all the users to add to the workflow, comma separated
settings{xml}Pass additional information when updating the workflow. Example: <name>New Name</name>

Response Information

ElementDescription
<status>A status code in response to the operation.
<message>Additional information about the operation – human readable.

Sample Request

POST https://api-app.xtracta.com/v1/workflow/update HTTP/1.1
api_key=123&user_ids=123,456,789

Sample Response

<?xml version="1.0" encoding="UTF-8"?>
<workflow_response>
    <status>200</status>
    <message>The request has been successfully processed</message>
</workflow_response>

Schema Definition

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">

  <xs:simpleType name="ConfidenceType">
    <xs:union>
      <xs:simpleType>
        <xs:restriction base="xs:integer">
          <xs:minInclusive value="0"/>
          <xs:maxInclusive value="100"/>
        </xs:restriction>
      </xs:simpleType>
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:enumeration value=""/>
        </xs:restriction>
      </xs:simpleType>
    </xs:union>
  </xs:simpleType>

  <xs:element name="workflow_response">
    <xs:complexType>
      <xs:sequence>
      <xs:element name="status" type="xs:positiveInteger"/>
      <xs:element name="message" type="xs:string"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>

</xs:schema>