Add recipient to survey

POST

/v1/Survey/Surveys/{id}/Recipients

curl --request POST \
  --url https://rms.dev.caspeco.net/api/booking/v1/Survey/Surveys/example/Recipients \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'system: example' \
  --data '{ "ref": "example", "name": "example", "emailAddress": "example", "mobilePhone": "example", "invitationMethod": 0, "sendTime": "2026-04-15T12:00:00Z", "remindTime": "2026-04-15T12:00:00Z", "replaceParams": { "additionalProperty": "example" }, "callbackUrl": "example", "referenceTime": "2026-04-15T12:00:00Z" }'

Adds the recipient to the survey. To send it, use the Recipients Controller with the recipient id.

Authorizations

• oauth2
  api1
• pat
  api1

Parameters

Path Parameters

id

required

string

The id of the requested survey

Header Parameters

system

required

string

The system name / database to query

Request Body^required

The recipient and send data

Media typeapplication/json

object

ref

string

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

replaceParams

object

key

additional properties

string

callbackUrl

string

nullable

referenceTime

string format: date-time

nullable

Responses

200

The updated Survey structure

Media typeapplication/json

object

id

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.6647775+00:00",
    "name": "Lennart Lennartsbesökare",
    "emailAddress": "lennart@lennart.se",
    "mobilePhone": "0701234567",
    "invitationMethod": 0,
    "sendTime": "2025-12-01T12:50:09.6647758+00:00",
    "remindTime": "2025-12-01T17:50:09.6647774+00:00",
    "callbackCallCount": 0,
    "callbackCallSuccess": false,
    "status": 1,
    "replaceParams": {
      "name": "Lennart",
      "personalMsg": "Glöm inte att sälja din freestyle Lennart!"
    }
  }
}