Sign in

v1

latestOpenAPI 3.0.12026-07-243266138.0 KB

Modify Invite Settings by id

Modifies parts of the Invite Settings entity object with the identifier matching the provided id value.

patch/invite-settings/{id}

Path parameters

idstring required

The Invite Settings identifier.

Request body

enabledboolean

Example request

{
  "enabled": true,
  "productInviteConfiguration": {
    "sendingDelayInDays": 7,
    "sendingTimeOfDay": "07:15:00Z",
    "inviteTemplateId": "tpl-6ccace5e-cd7c-4add-9217-87e411e9a79f",
    "questionnaireTemplateId": "qst-f58de863-a0fa-43f6-bdc2-847f9247c9ec",
    "enabled": true
  },
  "serviceInviteConfiguration": {
    "sendingDelayInDays": 7,
    "sendingTimeOfDay": "07:15:00Z",
    "inviteTemplateId": "tpl-c31c696d-a70e-450a-a842-58370b401cd8",
    "questionnaireTemplateId": "qst-93fc31d6-e3f4-4554-b279-8059550995d8",
    "enabled": true
  }
}

Response

The modified Invite Settings entity object.

idstring required
channelIdstring required
eventTypeIdstring required
enabledboolean required
createdAtstring datetime required
updatedAtstring datetime required

Example response

{
  "id": "is-4c00ebfe-c5b7-4691-b713-fb053352b4ec",
  "channelId": "chl-89861a03-2fa9-42e6-bc9f-77f270d965f1",
  "eventTypeId": "ety-d120cd0b-03f3-4f8b-ba59-df017249171e",
  "enabled": true,
  "productInviteConfiguration": {
    "sendingDelayInDays": 7,
    "sendingTimeOfDay": "07:15:00Z",
    "inviteTemplateId": "tpl-6ccace5e-cd7c-4add-9217-87e411e9a79f",
    "questionnaireTemplateId": "qst-f58de863-a0fa-43f6-bdc2-847f9247c9ec",
    "enabled": true
  },
  "serviceInviteConfiguration": {
    "sendingDelayInDays": 3,
    "sendingTimeOfDay": "07:15:00Z",
    "inviteTemplateId": "tpl-c31c696d-a70e-450a-a842-58370b401cd8",
    "questionnaireTemplateId": "qst-93fc31d6-e3f4-4554-b279-8059550995d8",
    "enabled": true
  },
  "createdAt": "2022-08-10T17:00:00.000Z",
  "updatedAt": "2022-08-10T17:09:19.000Z"
}