Bevy API GDG

Create Prospective User

POST

/user/create_prospective_user/

User

Creates a prospective user. A prospective user is a user that has not signed in for the first time.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/user/create_prospective_user/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "user@mail.com",
    "first_name": "John",
    "last_name": "Doe",
    "send_welcome_emails": true
}'

Response Example

201 - Example 1

{
    "authentication_providers": [
        {
            "provider": "google-oauth2",
            "provider_user_id": 1234
        }
    ],
    "avatar": {
        "url": "https://res.cloudinary.com/startup-grind/image/upload/.../image.png",
        "path": "image.png",
        "thumbnail_width": 720,
        "thumbnail_height": 540,
        "thumbnail_format": "auto",
        "thumbnail_url": "https://res.cloudinary.com/startup-grind/image/upload/.../image.png"
    },
    "company": "Bevy",
    "cropped_avatar_url": "https://res.cloudinary.com/startup-grind/image/fetch/.../image.jpeg",
    "extra_data": {},
    "title": "Mr.",
    "role": {
        "id": 1234,
        "name": "Prospective",
        "description": "Prospective Member",
        "user_active_status": true
    },
    "email": "user@mail.com",
    "first_name": "John",
    "id": 1234,
    "last_name": "Doe",
    "username": "string"
}

Request

Body Params application/json

string

required

Example:

user@mail.com

first_name

string

required

Example:

John

last_name

string

required

Example:

Doe

send_welcome_emails

boolean

optional

Whether to send new user welcome emails to the newly created user. Default to false.

Example:

true

Examples

Responses

🟢201Created

application/json

Prospective user created.

Body

authentication_providers

array [object {2}]

optional

provider

string

optional

Example:

google-oauth2

provider_user_id

integer

optional

Example:

1234

avatar

object (Image)

optional

url

string

optional

Example:

https://res.cloudinary.com/startup-grind/image/upload/.../image.png

path

string

optional

Example:

image.png

thumbnail_width

number

optional

Example:

720

thumbnail_height

number

optional

Example:

540

thumbnail_format

string

optional

Example:

auto

thumbnail_url

string

optional

Example:

https://res.cloudinary.com/startup-grind/image/upload/.../image.png

company

string

optional

Example:

Bevy

cropped_avatar_url

string

optional

Example:

https://res.cloudinary.com/startup-grind/image/fetch/.../image.jpeg

extra_data

object

optional

title

string

optional

Example:

Mr.

role

object

optional

integer

optional

Example:

1234

name

string

optional

Example:

Prospective

description

string

optional

Example:

Prospective Member

user_active_status

boolean

optional

Example:

true

string

required

Example:

user@mail.com

first_name

string

required

Example:

John

number

required

Example:

1234

last_name

string

required

Example:

Doe

username

string

required

🟠400Bad Request

🟠403Forbidden

List user's chapter teams

Opt out of emails