@spec create(map()) :: success_or_error()

Create a new member in your AdvocateHub

@spec find_by_email(String.t()) :: success_or_error()

Lookup a current member of your AdvocateHub by email

@spec find_by_id(integer() | String.t()) :: success_or_error()

Look up a current member of your AdvocateHub by their ID. Substituting the UUID for the ID also works with this endpoint.

@spec get_own_record() :: success_or_error()

Get information about your API user

Query All Members In Your AdvocateHub

@spec lock_profile(integer() | String.t()) :: success_or_error()

Lock an Advocates profile identified by ID or UUID

@spec recently_updated(past_hours :: integer()) :: success_or_error()

This will return a list of the UUIDs of Advocates who's profile has been updated within the past_hours (Offset in hours from current time)

@spec send_invite(integer(), boolean()) :: success_or_error()

Send an invitation to a previously uninvited member. This endpoint will generate and return an invite link.

Note: This will only send an invite once, if you try to repeat the call to send a second invite to a given member, it will not work

@spec unlock_profile(integer() | String.t()) :: success_or_error()

Lock an Advocates profile identified by ID or UUID

@spec unsubscribe(String.t()) :: success_or_error()

Unsubscribe a member of your AdvocateHub from emails based on their email address

@spec update(integer(), map()) :: success_or_error()

To update an existing member of your AdvocateHub

Note: Email address cannot be changed. Note: Name, Title, Company, CRM Contact ID, Other External IDs, and Match Criteria can be updated in this call.