Ideas portal users API

Unsubscribe portal user from all communications

PUT /api/v1/idea_portals/:idea_portal_id/portal_users/:id

Parameters
Name	Description
`idea_portal_id *`	Numeric ID of the idea portal
`id *`	Numeric ID of the portal user
`email`	Email address of the portal user. The email address does not need to be of a user of Aha!
`first_name`	First name of the portal user
`last_name`	Last name of the portal user
`permission`	Whether the portal user is an employee/partner. Must be 'true' or 'false'
`enabled`	Whether the portal user is active. Must be 'true' or 'false'
`max_endorsement_override`	The vote allocation for this specific user
`unsubscribed`	Whether the portal user has been unsubscribed from all communications from this portal
`unsubscribed_from_weekly_emails`	Whether the portal user has been unsubscribed from weekly portal summary email

Example request

PUT /api/v1/idea_portals/1070474755/portal_users/646391926

Example CURL command

curl "https://company.aha.io/api/v1/idea_portals/1070474755/portal_users/646391926" -d '{"portal_user":{"unsubscribed":true,"unsubscribed_from_weekly_emails":true}}' -X PUT \
	-H "Authorization: Bearer 584b6d6b83405011f8c6903d2379f4afdf824cef867db391b7bcb5995f603a76" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

authorization: Bearer 584b6d6b83405011f8c6903d2379f4afdf824cef867db391b7bcb5995f603a76
contentType: application/json
accept: application/json

Request body

Response

Status: 200 OK
contentType: application/json; charset=utf-8

Response body