Client API – Displays API

Modified on Thu, Oct 23 at 7:22 AM

Create a new display for a valid survey ID.
If a userId is passed, the display is linked to that user.

POST /api/v1/client/{environmentId}/displays

Name	Type	Required	Description
`environmentId`	`string`	✅	The environment ID is available under Project’s Configuration → Website & App Connection.

Content Type: application/json

Status: 200 OK
Content Type: application/json

{
  "data": {
    "id": "clvc1z8200006494jgnds7ort"
  }
}

Update an existing display. Common use: mark the display as closed.

PUT /api/v1/client/{environmentId}/displays/{displayId}

Name	Type	Required
`environmentId`	`string`	✅
`displayId`	`string`	✅

Content Type: application/json

Status: 200 OK
Content Type: application/json

{
  "data": {}
}