Sign in

v1

latestOpenAPI 3.0.12026-07-243266138.0 KB

Modify all Invite Settings in the Account

Updates parts of all invite settings with the same event-type ID for all channels

patch/invite-settings

Query parameters

event-type-idstring required

The Event Type identifier to filter all Invite Settings entity objects by, before trying to apply the desired modification. Only the Invite Settings entity objects whose Event Type identifier matches this parameter will be updated.

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 collection of the modified Invite Settings entity objects, across all Channels of the Account, in which the request originates.

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"
  }
]