Profiles
profile url
Helper endpoint to verify if a profile url is taken for a given campaign, and make suggestions if the path queried is not available
For custom components:
RaiselyComponents.api.all('utils').get('profile-url', params = {}, headers = {}) => Promise<{result}>
:fa-gears: See Restie Response Data for a more detailed overview of responses through the client wrapper
get/utils/profile-url
Query parameters
campaignUuidstring required
The uuid of the campaign to associated with the request
urlstring
Example:profile
The profile path to check (optional)
namestring
Example:profile
The profile name to use to check and use to generate a path
type'individual' | 'group' | 'team'
The profile type to use to check and use to generate a path
Headers
Authorizationstring
A valid HTTP Bearer token, required to access private records.
Response
The result fo the profile-url query
Example response
{
"suggestions": [
"profile1",
"profile1"
]
}