DELETE /api/workflow/definitions/{WorkflowDefKey}

Deletes the specified custom workflow.

Authorization Roles/Permissions: Must be logged in. Must have permission to modify the business information; Site Admin

This topic includes the following sections:

HTTP Method

DELETE

https://{hostname}/api/workflow/definitions/{WorkflowDefKey}

The example below shows a request to delete the specified custom workflow.

Sample Request URL

https://{hostname}/api/workflow/definitions/ce5a0e7e-f86f-4a17-bd02-0a386035d81f

Sample request headers

Accept: text/plain
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

Not applicable.

For general information on request header values, refer to HTTP Request Headers.

Header	Description
Accept	Any Accept header value that supports a response Content-Type of text/plain is valid; for example, */*.
Cookie	AtmoAuthToken_{fedmemberid}={cookie value, which usually starts with TokenID}—The platform cookie. This is the Akana API Platform authorization token, and must be sent with every API request that requires login. For more information and an example, see Session cookies.
X-Csrf-Token_{fedmemberID}	The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login.

Parameter	Parm Type	Data Type	Required	Description
WorkflowDefKey	Path	string	Required	The unique workflow definition key for the applicable workflow.

If successful, this operation returns HTTP status code 200, with Boolean true indicating that the workflow was deleted.

The sample response below shows successful completion of this operation.

Sample response headers

Status Code: 200 OK
Date: Wed, 11 Mar 2020 15:24:57 GMT
Content-Type: text/plain

Sample response body

true

For general information on response header values, refer to HTTP Response Headers.

Header	Description
Content-Type	text/plain

The response body is text, Boolean true indicating that the workflow was deleted.

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item	Value
401	Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.
500	An error occurred processing the call.