Cancel the survey

POST

/v1/Survey/Recipients/{id}/Cancel

const url = 'https://rms.dev.caspeco.net/api/booking/v1/Survey/Recipients/example/Cancel';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://rms.dev.caspeco.net/api/booking/v1/Survey/Recipients/example/Cancel \
  --header 'Authorization: Bearer <token>'

Makes the survey invalid. Any scheduled sendings or reminders will be disabled

Authorizations

oauth2
api1
pat
api1

Parameters

Path Parameters

required

string

The id of the recipient

Responses

200

The recipient

application/json

object

string format: guid

rev

integer format: int64

surveyId

string format: guid

ref

string

nullable

referenceTime

string format: date-time

nullable

name

string

nullable

emailAddress

string

nullable

mobilePhone

string

nullable

invitationMethod

integer

Allowed values: 0 1 2

sendTime

string format: date-time

nullable

remindTime

string format: date-time

nullable

callbackUri

string

nullable

sentTime

string format: date-time

nullable

remindedTime

string format: date-time

nullable

openedTime

string format: date-time

nullable

respondedTime

string format: date-time

nullable

callbackCallCount

integer format: int32

callbackCallSuccess

boolean

callbackCalledTime

string format: date-time

nullable

status

integer

Allowed values: 0 1 2 3 4 5 6 999

replaceParams

object

key

additional properties

string

Example

{
  "application/json": {
    "id": "aa2af7b1-c640-4d4b-a9b2-8eaf68b446b7",
    "rev": 0,
    "surveyId": "ff07bf69-8453-4c1b-b407-1a3467a4109a",
    "referenceTime": "2025-12-01T07:50:09.6536432+00:00",
    "name": "Lennart Lennartsbesökare",
    "emailAddress": "lennart@lennart.se",
    "mobilePhone": "0701234567",
    "invitationMethod": 0,
    "sendTime": "2025-12-01T12:50:09.6536417+00:00",
    "remindTime": "2025-12-01T17:50:09.653643+00:00",
    "callbackCallCount": 0,
    "callbackCallSuccess": false,
    "status": 1,
    "replaceParams": {
      "name": "Lennart",
      "personalMsg": "Glöm inte att sälja din freestyle Lennart!"
    }
  }
}