Profile

Get Profile

get
Query parameters
company_idintegerOptional

The ID of the company to which the profile belongs

profile_idintegerOptional

The ID of the profile to retrieve

pathstringOptional

The path associated with the profile

Responses
200

Successful retrieval of the profile.

application/json
get
/profile
200

Successful retrieval of the profile.

Create a Profile

post
Body
namestringOptional

The name of the profile

jobstringOptional

The job title associated with the profile

companystringRequired

The company name associated with the profile

descriptionstringOptional

A brief description of the profile

image_profilestringOptional

URL to the profile image

image_companystringOptional

URL to the company image

image_bannerstringOptional

URL to the banner image

backgroundstringOptional

Background information for the profile

textstringOptional

Text content associated with the profile

amountintegerOptional

The number of profiles to create

Default: 1
Responses
200

Successful creation of the profile.

application/json
post
/profile
200

Successful creation of the profile.

Update Profile

put
Body
anyOptional
or
anyOptional
Responses
200

Successfully updated the profile.

application/json
put
/profile
200

Successfully updated the profile.

Delete Profile

delete
Body
profile_idintegerRequired

The ID of the profile to delete

Responses
200

Successfully deleted the profile.

application/json
delete
/profile
200

Successfully deleted the profile.

Create Multiple Profiles

post
Body
company_idintegerRequired

The ID of the company for which profiles are being created

filestring · binaryOptional

A file containing profile data (optional)

countintegerOptional

Number of profiles to create (optional)

emailsstring · email[]Optional

An array of email addresses to create profiles for (optional)

send_walletbooleanOptional

Whether to send wallet links to the created profiles

Default: false
new_profilesobjectOptional

Details for the new profiles if creating multiple profiles with a count

Responses
200

Successful creation of the profiles.

application/json
post
/profiles
200

Successful creation of the profiles.

Update Profile Name and Company

get
Query parameters
profile_idintegerRequired

The ID of the profile to update

namestringRequired

The new name for the profile

emailstring · emailRequired

The email associated with the profile

company_namestringRequired

The new company name for the profile

Responses
200

Successfully updated the profile.

application/json
get
/profile/edit
200

Successfully updated the profile.

Last updated