Capture Near Miss Prompt Response

PUT 
/client/users/:correlation_id/prompts/:promptMessage_id

• This call captures the response to Near Miss Prompt message from the Trial Activity call
• Prompt message id can be obtained from the trial activity call response attribute: promptMessageID
• Possible values for response are: accepted/declined/deferred

Request

Body

Attribute	Definition	Format	Notes
response	Query about the response to the Near Miss Prompt message from the Trial Activity call.	Enum: "accepted", "declined", "deferred"	"deferred" means delayed until a later time

Response

Attribute	Definition	Format	Notes
message	Provides a message about the response to the Near Miss Prompt message from the Trial Activity call	String	For example: "Customer's response captured successfully."

Error Responses

statusCode	errorMessage	errorCode	Definition
400 Bad Request	{response} is not a valid response	INVALID_REQUEST	When 'response' (body) is empty or invalid. Valid options: 'accepted', 'declined', or 'deferred'
400 Bad Request	{{promptMessage_id}} is not a valid promptMessageId	INVALID_REQUEST	When 'promptmessage_id' is not valid
400 Bad Request	Session correlation ID does not exist--create it first	INVALID_REQUEST	Must create a session correlation_id before sending this request

Request

Responses

200

200 - Near Miss Prompt Response Captured

Response Headers

Date
Example: Tue, 16 Feb 2021 00:03:43 GMT
Content-Length
Example: 56
Connection
Example: keep-alive
x-amzn-RequestId
Example: 2b1c79bd-aa07-4a0e-bfda-4f8f5cdfad24
Referrer-Policy
Example: no-referrer
X-XSS-Protection
Example: 1;mode=block
Access-Control-Allow-Origin
Example: *
Expect-CT
Example: max-age=86400
Strict-Transport-Security
Example: max-age=31536000
Feature-Policy
Example: vibrate 'none'; geolocation 'none'
X-Frame-Options
Example: sameorigin
Content-Security-Policy
Example: connect-src 'none';object-src https://*.cloudfront.net;script-src https://*.cloudfront.net
x-amz-apigw-id
Example: az7K4GrfoAMFhfA=
cache-control
Example: no-cache, no-store, must-revalidate
X-Content-Type-Options
Example: nosniff
X-Amzn-Trace-Id
Example: Root=1-602b0bdf-158ab29329606e8939f2b0d4;Sampled=0

400

400 - {response} is Not Valid

Response Headers

Date
Example: Tue, 16 Feb 2021 01:17:35 GMT
Content-Length
Example: 99
Connection
Example: keep-alive
x-amzn-RequestId
Example: 17e7c432-ebaa-4c11-ac2b-9d0a43c8af5e
Referrer-Policy
Example: no-referrer
X-XSS-Protection
Example: 1;mode=block
Access-Control-Allow-Origin
Example: *
Expect-CT
Example: max-age=86400
Strict-Transport-Security
Example: max-age=31536000
Feature-Policy
Example: vibrate 'none'; geolocation 'none'
X-Frame-Options
Example: sameorigin
Content-Security-Policy
Example: connect-src 'none';object-src https://*.cloudfront.net;script-src https://*.cloudfront.net
x-amz-apigw-id
Example: a0F_WG1UoAMFnVA=
cache-control
Example: no-cache, no-store, must-revalidate
X-Content-Type-Options
Example: nosniff
X-Amzn-Trace-Id
Example: Root=1-602b1d2e-2bf3661527299bd439155b6e;Sampled=0