Create User
| Time | Status | User Agent | |
|---|---|---|---|
| Make a request to see history. |
URL Expired
The URL for this request expired after 30 days.
Create a User
A user must be created with either a role or permissions. In other words, either the
role_idor thepermsparameters must be provided. For further details of thepermsparameter, see thePermssection below.time_zoneis a required field and follows the IANA time zone identifier format. For example,America/Los_Angeles,Europe/London,Asia/Tokyo, etc.If
funnel_idsare provided, user will be given access to the openings associated with thesefunnel_idsIf
location_idsare provided, user will be given access to locations associated with theselocation_idssend_invitation (optional, boolean): when true, an invitation is sent to the user after creation. Invitations are only sent when the account does not have unified auth enabled. Default is false.
ℹ️
Perms
Instead of assigning a role to a user, the user can also be granted access to permissions directly using the
permsparameter.An example of the
permsparameter looks like{ "manage_applicants": "1", "manage_users": "1", "manage_sourcing": "1" }. Namely, it is a JSON object where the keys are the permissions we want to grant, and the value is a "1".Here is a comprehensive list of all the permission keys:
- add_notes
- analytics
- api
- applicants
- billing
- bulk_edit_funnels
- communications
- create_applicants
- create_funnels
- custom_fields
- custom_reports
- delete_applicants
- delete_shifts
- edit_pipeline_ratio
- edit_shifts
- embedded_signature_templates
- exports
- funnels
- integrations
- manage_all_slots
- manage_applicants
- manage_approval_of_created_openings
- manage_approvers
- manage_calendar_export
- manage_funnels
- manage_hiring_goals
- manage_own_sessions
- manage_own_slots
- manage_sourcing
- manage_users
- manage_workers
- manage_workflows
- message_templates
- message_templates_management
- partner_integrations
- post_to_job_boards
- posthire_checks
- reasons
- reports
- resubmit_partner_data
- scheduling
- scorecards
- secure_data
- secure_files
- secure_i9
- secure_signed_documents
- secure_w4
- send_messages_from_user
- shifts
- text_to_apply
- view_applicants
- view_funnels
- view_message_templates
- view_shifts
- view_workers
- view_workflows
- workers
- workflows
Users
- email: string (required)
- name: string (required)
- time_zone: string (enum, required)
Acceptable values for time_zone include:
Africa/Algiers
Africa/Cairo
Africa/Casablanca
Africa/Harare
Africa/Johannesburg
Africa/Monrovia
Africa/Nairobi
America/Argentina/Buenos_Aires
America/Bogota
America/Caracas
America/Chicago
America/Chihuahua
America/Denver
America/Godthab
America/Guatemala
America/Guyana
America/Halifax
America/Indiana/Indianapolis
America/Juneau
America/La_Paz
America/Lima
America/Los_Angeles
America/Mazatlan
America/Mexico_City
America/Monterrey
America/Montevideo
America/New_York
America/Phoenix
America/Puerto_Rico
America/Regina
America/Santiago
America/Sao_Paulo
America/St_Johns
America/Tijuana
Asia/Almaty
Asia/Baghdad
Asia/Baku
Asia/Bangkok
Asia/Chongqing
Asia/Colombo
Asia/Dhaka
Asia/Hong_Kong
Asia/Irkutsk
Asia/Jakarta
Asia/Jerusalem
Asia/Kabul
Asia/Kamchatka
Asia/Karachi
Asia/Kathmandu
Asia/Kolkata
Asia/Krasnoyarsk
Asia/Kuala_Lumpur
Asia/Kuwait
Asia/Magadan
Asia/Muscat
Asia/Novosibirsk
Asia/Rangoon
Asia/Riyadh
Asia/Seoul
Asia/Shanghai
Asia/Singapore
Asia/Srednekolymsk
Asia/Taipei
Asia/Tashkent
Asia/Tbilisi
Asia/Tehran
Asia/Tokyo
Asia/Ulaanbaatar
Asia/Urumqi
Asia/Vladivostok
Asia/Yakutsk
Asia/Yekaterinburg
Asia/Yerevan
Atlantic/Azores
Atlantic/Cape_Verde
Atlantic/South_Georgia
Australia/Adelaide
Australia/Brisbane
Australia/Darwin
Australia/Hobart
Australia/Melbourne
Australia/Perth
Australia/Sydney
Etc/GMT+12
Europe/Amsterdam
Europe/Athens
Europe/Belgrade
Europe/Berlin
Europe/Bratislava
Europe/Brussels
Europe/Bucharest
Europe/Budapest
Europe/Copenhagen
Europe/Dublin
Europe/Helsinki
Europe/Istanbul
Europe/Kaliningrad
Europe/Kiev
Europe/Lisbon
Europe/Ljubljana
Europe/London
Europe/Madrid
Europe/Minsk
Europe/Moscow
Europe/Paris
Europe/Prague
Europe/Riga
Europe/Rome
Europe/Samara
Europe/Sarajevo
Europe/Skopje
Europe/Sofia
Europe/Stockholm
Europe/Tallinn
Europe/Vienna
Europe/Vilnius
Europe/Volgograd
Europe/Warsaw
Europe/Zagreb
Europe/Zurich
Pacific/Apia
Pacific/Auckland
Pacific/Chatham
Pacific/Fakaofo
Pacific/Fiji
Pacific/Guadalcanal
Pacific/Guam
Pacific/Honolulu
Pacific/Majuro
Pacific/Midway
Pacific/Noumea
Pacific/Pago_Pago
Pacific/Port_Moresby
Pacific/Tongatapu
UTC
role_id: string
perms: object
funnel_ids: array of strings
location_ids: array of strings
send_invitation: boolean (Defaults to true)
Responses
201: OK422: validation error - missing role_id and perms
Example CURL Request
curl --request POST \
--url https://api.fountain.com/v2/users \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '
{
"time_zone": "Africa/Algiers",
"send_invitation": true
}'