Skip to main content
POST
/
v4
/
user
Create platform user
curl --request POST \
  --url https://api.example.com/v4/user \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-meetergo-api-user-id: <api-key>' \
  --form [email protected] \
  --form 'givenName=<string>' \
  --form 'familyName=<string>' \
  --form 'slug=<string>' \
  --form timezone=America/New_York \
  --form 'availability={
  "name": "<string>",
  "schedule": {
    "monday": {
      "enabled": true,
      "hours": [
        {
          "start": "<string>",
          "end": "<string>"
        }
      ]
    },
    "tuesday": {
      "enabled": true,
      "hours": [
        {
          "start": "<string>",
          "end": "<string>"
        }
      ]
    },
    "wednesday": {
      "enabled": true,
      "hours": [
        {
          "start": "<string>",
          "end": "<string>"
        }
      ]
    },
    "thursday": {
      "enabled": true,
      "hours": [
        {
          "start": "<string>",
          "end": "<string>"
        }
      ]
    },
    "friday": {
      "enabled": true,
      "hours": [
        {
          "start": "<string>",
          "end": "<string>"
        }
      ]
    },
    "saturday": {
      "enabled": true,
      "hours": [
        {
          "start": "<string>",
          "end": "<string>"
        }
      ]
    },
    "sunday": {
      "enabled": true,
      "hours": [
        {
          "start": "<string>",
          "end": "<string>"
        }
      ]
    }
  },
  "timezone": "<string>"
}' \
  --form 'meetingType={
  "name": "<string>",
  "duration": 2,
  "slug": "<string>",
  "daysIntoFuture": {
    "mode": "<string>",
    "bookingLimit": 123,
    "rangeMin": "2023-11-07T05:31:56Z",
    "rangeMax": "2023-11-07T05:31:56Z"
  }
}'
{
  "userId": "550e8400-e29b-41d4-a716-446655440000",
  "availabilityId": "660e8400-e29b-41d4-a716-446655440001",
  "meetingTypeId": "770e8400-e29b-41d4-a716-446655440002",
  "bookingUrl": "https://book.customdomain.com/john-doe/30min-meeting",
  "companyId": "880e8400-e29b-41d4-a716-446655440003"
}

Authorizations

​
x-meetergo-api-user-id
string
header
required

User ID to act as when using API Key authentication (required with API Key)

Body

multipart/form-data
​
email
string<email>
required

The email address of the user

​
givenName
string

The first name of the user. Defaults to the email prefix

​
familyName
string

The last name of the user. Defaults to empty string

​
slug
string

Optional unique slug for the user (minimum 5 characters). Defaults to creating slug via the email.

Minimum string length: 5
​
timezone
string

User timezone. Defaults to "Europe/Berlin"

Example:

"America/New_York"

​
availability
object

Availability configuration. Creates default availability if not specified

​
meetingType
object

Meeting type configuration. Creates default meeting type if not specified

Response

201 - application/json

Platform user created successfully with auto-generated availability and meeting type. Returns user ID, availability ID, meeting type ID, company ID, and public booking URL that customers can use immediately.

​
userId
string
required

Unique ID of the created platform user

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
availabilityId
string
required

ID of the created availability schedule

Example:

"660e8400-e29b-41d4-a716-446655440001"

​
meetingTypeId
string
required

ID of the created meeting type

Example:

"770e8400-e29b-41d4-a716-446655440002"

​
bookingUrl
string
required

Public URL where customers can book appointments

Example:

"https://book.customdomain.com/john-doe/30min-meeting"

​
companyId
string
required

ID of the company this user belongs to

Example:

"880e8400-e29b-41d4-a716-446655440003"