Sign in

v1

latestOpenAPI 3.0.12026-07-243266138.0 KB

Retrieve all Invite Settings in the Account

Produces the collection of all Invite Settings entity objects across all Channels in the Account, in which the request originates.

The list can be filtered by any subsets of the following query constraint parameters:

  • Invite Settings identifier,
  • Event Type identifier,
  • Channel identifier.

Note:

  • If no parameters are provided, all Invite Settings entity objects in the Account will be produced.
  • Limitation: To retrieve more than 5000 Invite Settings entity objects at once, implement pagination using the query string parameters.
get/invite-settings

Query parameters

idstring

The Invite Settings identifier to retrieve the entity object by (only this entity object, if exists).

channel-idstring

The Channel identifier to filter the retrievable Invite Settings entity objects by.

event-type-idstring

The Event Type identifier to filter the retrievable Invite Settings entity objects by.

Response

The collection of all Invite Settings entity objects across all Channels in 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"
  }
]