Recipient model

Recipient may be an MPC member (identified by member_id) or an arbitrary sending receivers - msisdn, email or push.

Example

{
  "member_id": 150,
  "msisdn": "4740769126",
  "email": "recipient@example.com",
  "app_token": "c6OE_joK28g:APA91bFkT5fzhdWJMJswPo3btVLxtMmhi7jKdOE_VL1IhkSmuoz3iEQMg4Cq",
  "properties": { "first_name": "Piotr" }
}

Definition

Key	Type	Description
member_id	integer	ID of MPC member
msisdn	MSISDN
email	email
app_token	email
properties	Object	Arbitrary keys that can be used as merge-tags in the message template

MPC member recipient

When member_id is provided, other identifiers will be ignored and actual identifiers for sending execution will
be fetched from MPC member's data (for example, for sms channel member's msisdn will be used as a sending receiver).

merge-tags for template will be fetched from MPC Members - but may be extended/replaced with provided properties.

Arbitrary identifier recipient

Without member_id, at least one identifier relevant to message's channels definition is required.

For example, if sms and email channels are defined on message, msisdn or email is required.

Given properties will be used as template's merge-tags.

Dispatch member model

Member to whom dispatch has been sent

Example

{
    "id": 173,
    "type": "sms",
    "msisdn": null,
    "email": null,
    "app_tokens": ["token_1", "token_2"]
}

Key	Type	Description
id	integer	Member id
type	enum: ['sms', 'email', 'push']
msisdn	string
email	string
app_tokens	array	array of app_tokens

Example#

Definition#

MPC member recipient#

Arbitrary identifier recipient#

Dispatch member model#

Example#

Example

Definition

MPC member recipient

Arbitrary identifier recipient

Dispatch member model

Example