Fulfillment

Update a respondent's status

Updates the respondent's status defined by the status code in the body of the request.

The following table contains the possible codes that can be supplied in the body's status field:

Cint Status DefinitionS2S Code
Complete5
Screenout2
Quality Terminate4
Quota Full3
post/fulfillment/respondents/transition

Request

Headers

Authorizationstring required
Example:<api_key>

API Key for authentication.

Request body

idstring required

The session ID (RID) of the respondent.

statusinteger required

The status to which the respondent is being transitioned.

Example request

{
  "id": "6780395e-94fa-1eb7-612c-d2e19af42758",
  "status": 5
}

Response

The respondent's status was successfully updated.

idstring

The session ID (RID) of the respondent whose status was updated.

statusinteger

The status to which the session (RID) was updated to.

Example response

{
  "id": "6780395e-94fa-1eb7-612c-d2e19af42758",
  "status": 5
}

Changes

No recorded changes to this operation across all 1 revision of this API.