Remove Participants

Remove participants of a draft/template workflow owned by the user’s organization.

Request

POST https://api.cloudplan.net/api/workflow/remove_participants

{
    "cp_id": "5F22DEFB0F61A9257BA4521664C62711",
    "users": ["user1@user1.com","user2@user2.com"]
}

Reply

{
    "status": 200,
    "result": true,
    "params": {
        "cp_id": "5F22DEFB0F61A9257BA4521664C62711",
        "users": ["user1@user1.com","user2@user2.com"]
    },
    "data": {
        "signing_steps": [
            []
        ],
        "organisation_cp_id": "56BCC4218F5CE591E3EE5A9599694845",
        "template_visible": "only_creator",
        "project_type": "document",
        "project_name": "qqqq",
        "project_description": "nothing",
        "process_mode": "one_copy_for_each_signer",
        "target_folder_cp_id": "5ECE77176D70DAF6EFA685DBDA719957",
        "project_message_signer": "sssssssssssssssssssssss",
        "project_runtime": 604800,
        "project_remind_freq": 86400,
        "signing_steps_used": false,
        "target_folder_cp_id": "5E58D529AC4CCEFC31E8AAC9E32BCH77",
        "documents": [
            {
                "file_cp_id": "VGVZDGZPBGUTMTQ5",
                "file_name": "Testfile-149Loremipsumdolorsitametconsect.pdf",
                "folder_cp_id": "5ECE77176D70DAF6EFA685DBDA719957",
                "file_options": []
            },
            {
                "file_cp_id": "5F1AB1FD371382D05B88FD3FB0BBBA9D",
                "file_name": "File-1",
                "folder_cp_id": "plain",
                "file_options": []
            }
        ],
        "creator_cp_id": "5DF20CE3DD3DBE0EE1397A5977E781A8",
        "cp_id": "5F22DEFB0F61A9257BA4521664C62711",
        "created": 1596120827,
        "status": "draft",
            ...
    }
}

Error Codes

workflow_not_found
workflow_not_a_draft_or_template
no_remove_users_provided
invalid_cp_id