Award Points for actions that happen outside of Influitive. Can also be used to advance challenges or log acts of advocacy

Log in to see full request history

Note: If you use an email that doesn't exist in your AdvocateHub then we will create a profile for them while logging the event.

Creating a Custom Event in the AdvocateHub

You must create a custom event and supply the event code with each request. Please refer to the below article for instructions on setting up Custom Events in your AdvovcateHub:

https://support.influitive.com/article/142-api-setting-up-custom-event-types

Configuring an API integrated stage into a challenge (Optional)

If you'd like your event to progress a challenge refer to the below article for instructions on setting up Custom Events in your AdvovcateHub that progress challenges:

https://support.influitive.com/article/439-challenge-stage-api-integration

Advocacy Object Details

  • advocacy_type - string, required field. The code of the advocacy type you want to create. A complete list can be found here
  • content - string, required field. The details of the what the contact did that will be displayed in the Influitive app and anywhere Acts of Advocacy are connected to.
  • source_title - string, required field. The name of where this advocacy happened used as they hyperlink text for the source_url
  • source_url - string, required field. Link to the source of where this advocacy happened (Must include "https://...")
  • occurred_at - date, optional field. The Date the advocacy happened, the format is year, month, day ie. 2022-10-18. If not provided, the date will be today's date

Note: You cannot send advocacy along with stage parameter

Body Params
string
required

The API code for the custom event created in the AdvocateHub

string

Points that are to be awarded to the advocate. If a stage code is provided, advocates will earn the number of points configured into the challenge.

Responses

Language
Click Try It! to start a request and see the response here! Or choose an example:
text/plain