Elvanto

Adds a person to a specified People Flow Step

POST
 https://api.elvanto.com/v1/peopleFlows/steps/addPerson.{json|xml|php}

Parameters

Name	Type	Description
step_id Required	string	The UUID of the People Flow Step you wish to add the person into.
person_id Required	string	The UUID of the Person you wish to add into the step.
assign_to	string	The UUID of the People Flow Step admin you wish to assign the person to.

Expected request JSON HTTP POST

{
    "step_id": "b63f3064-7be7-4fec-bc9a-1670518ac57f",
    "person_id": "da5bc5eb-04e2-43be-a174-6895f89b2416",
    "assign_to": "22af2200-1f5d-4ec1-9d0e-10af7978e3f8"
}

step_id=b63f3064-7be7-4fec-bc9a-1670518ac57f&person_id=da5bc5eb-04e2-43be-a174-6895f89b2416&assign_to=22af2200-1f5d-4ec1-9d0e-10af7978e3f8

Expected response JSON XML PHP

{
    "generated_in": "3.02",
    "status": "ok",
    "step_person": [
        "58783c9b-c573-4b96-b4ec-40e691fe51d3"
    ]
}

<?xml version="1.0" encoding="UTF-8"?>
<rsp generated_in="3.02" status="ok"/>

stdClass Object
(
    [generated_in] => 3.02
    [status] => ok
    [step_person] => stdClass Object
        (
            [0] => 58783c9b-c573-4b96-b4ec-40e691fe51d3
        )

)

Error responses

Please see our response status codes documentation for details of potential error responses for any API request.

250: The "step_id" parameter is required. A People Flow Step must be provided for the person to be added into.
250: The "person_id" parameter is required. A Person is required to be added into the People Flow Step
250: The "step_id" parameter is invalid. The People Flow Step UUID provided is not a valid UUID, or does not correspond to a People Flow Step in the system
250: The "person_id" parameter is invalid. The Person UUID provided is not a valid UUID, or does not correspond to a Person in the system
250: The "assign_to" parameter is invalid.