Post Share Email Event

post

https://example-client-domain.extole.io/api/v6/email/share

Calling this endpoint sends a share email through Extole on behalf of the user. The email share event is associated with the user by their share code. This endpoint will generate the share code for you based on your preferred codes; otherwise, the code will be a randomly generated string.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

recipient_email

string

required

The recipient's email address.

message

string

required

The custom email message the advocate shared with recipients if it was different from your default email message.

subject

string

The subject line of the email.

data

string

Additional details about the share event used for reporting and analytics. The only required element of the consumer_event object is the campaign_id, which is used to determine in which campaign the share message should be included.

campaign_id

string

The unique identifier for the campaign used for campaign selection purposes. If not passed, the normal campaign selection process will be used.

labels

string

Program labels as configured in My Extole for program selection purposes. If not passed, the normal campaign selection process will be used.

Headers

Authorization

string

Defaults to Bearer {access_token}

Content-Type

string

Defaults to application/json

Accepts

string

Defaults to application/json

Responses

Language

Credentials

Header

Loading…

Response

Choose an example:

application/json

200200

400400