After creating the API key you can Set up API calls. You can, for example, add participants with a call to the Community, unsubscribe participants or background information from a Community update participant.
On this page:
Set up API call for developers
Set up API call for developers
On the API overview page you will find an overview of the available API calls. After choosing the call Can a developer/IT person from your organization answer the call with the following information? of the API:
After creating the API key you can Set up API calls. You can, for example, add participants with a call to the Community, unsubscribe participants or background information from a Community update participant.
On this page:
Set up API call for developers
Set up API call for developers
On the API overview page you will find an overview of the available API calls. After choosing the call Can a developer/IT person from your organization answer the call with the following information? of the API:
- Choose on the overview page which API call you want to use.
- Add the API URL to connect.crowdtech.com. For example, you get connect.crowdtech.com/api/v1/survey/surveys.
- Place the API key in the header of the call 'X-API-key'.
Overview of available API calls
For Community you can set API calls for different parts, namely:
- Profiles
- Profile variables
- Bouncers
Profiles
- GET /profiles: get the profiles in a list
- POST /profiles: adding one or more new profiles/participants
- PATCH /profiles: update the information of one or more profiles in the Community
- DELETE /profiles: delete one or more profiles from the Community. Please note, this will remove all data from this respondent
- GET /profiles /profileID: get a profile
- PATCH /profiles /unsubscribe: Unsubscribes profiles from the Community. She can no longer be contacted after this
Profile variables
- GET /variables: pick up the profile variables and variable options from this Community
- POST /variables: adding one or more new profile variables and variable options to this Community
- PATCH /variables: updating existing profile variables and options in this Community
- DELETE /variables: delete one or more profile variables or variable options from this Community
Bouncers
- GET /bouncers: Get bouncers from a survey.