Sign in

v1

latestOpenAPI 3.0.12026-07-243266138.0 KB
Endpoints

Modify all Invite Reminder Settings in the Account

Modifies the desired parts of all Invite Reminder Settings for a given Event Type id within the active Account, in which the request is originating.

The desired modifications are expressed in the attached PATCH request body.

patch/invite-reminder-settings

Query parameters

event-type-idstring required

The Event Type id for the Invite Reminder Settings to update

Request body

enabledboolean

Example request

{
  "enabled": true,
  "serviceInviteReminderConfiguration": {
    "enabled": true,
    "sendingDelayInDays": 3,
    "inviteReminderTemplateId": "tpl-6ccace5e-cd7c-4add-9217-87e411e9a79f"
  },
  "productInviteReminderConfiguration": {
    "enabled": true,
    "sendingDelayInDays": 3,
    "inviteReminderTemplateId": "tpl-6ccace5e-cd7c-4add-9217-87e411e9a79f"
  }
}

Response

Collection of all Invite Reminder Settings entity objects for the provided Event Type within the active Account, in which the request is originating.

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

Example response

[
  {
    "id": "irs-2e2734bd-9ec4-4eb8-97ee-2499dd869196",
    "accountId": "acc-8f0ac134-1ebf-44d0-b407-c3ee6a0a0a1d",
    "channelId": "chl-89861a03-2fa9-42e6-bc9f-77f270d965f1",
    "eventTypeId": "ety-3ecaa096-05a3-43e6-a0bf-e157d638b9be",
    "enabled": true,
    "serviceInviteReminderConfiguration": {
      "enabled": true,
      "sendingDelayInDays": 3,
      "inviteReminderTemplateId": "tpl-6ccace5e-cd7c-4add-9217-87e411e9a79f"
    },
    "productInviteReminderConfiguration": {
      "enabled": true,
      "sendingDelayInDays": 3,
      "inviteReminderTemplateId": "tpl-6ccace5e-cd7c-4add-9217-87e411e9a79f"
    },
    "createdAt": "2022-08-10T17:00:00.000Z",
    "updatedAt": "2022-08-10T17:09:19.000Z"
  }
]