POST /users/:userId/referral-invites

Request

This route will send an invite email to a new user with an referal code that is linked to the current user.

Request Method:

• POST

Base URL:

• https://api.userdocks.com

End Point:

• /v1/users/:userId/referral-invites

Path Variables:

Variable	Type	Required	Description
:userId	String	true	the UUID of the user

Query Parameters:

None

HTTP Headers:

Note: Never use API Keys on the client

Note: Never use API Keys on the client

Access from your server via API keys:

Property	Type	Required	Access	Description
X-API-KEY	String	true	Only access to App	Api key for the userdocks app
X-API-KEY-TYPE	String	true	Only access to App	write
X-CLIENT-ID	String	true	Only access to App	UUID of the userdocks app

Access from the client via an access token:

Property	Type	Required	Access	Description
Authorization	String	true	Only access to this tenant	Access Token for userdocks tenant

HTTP Body:

Note: optional variables are marked with a ? (questionmark) at the end. Do not include the questionmark in the request.

A JSON object.

{
  "email": String,
  "language": String,
}

Response:

• Object

Example:

try {
  // call userdocks user management API
  const response = await fetch('https://api.userdocks.com/v1/users/:userId/referral-invites', {
    method: 'POST',
    headers: {
      // 'Authorization': String, // when accessed from the client e.g. `Bearer ${accessToken}`
      'X-API-KEY': String,
      'X-CLIENT-ID': String,
      'X-API-KEY-TYPE': 'write',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      email: String,
      language: String,
    }),
  });
  const { data } = await response.json();

  // do something with the data
} catch (err) {
  console.error(err);
  // handle error
}

Successful Response:

Can have the following HTTP Status Codes:

• 201 - Created

// POST /v1/users/:userId/referral-invites
{
  "success": Boolean,
  "message": String,
  "error": null,
  "data": null
}

Error Response:

Can have the following HTTP Status Codes:

• 400 - Bad Request
• 401 - Unauthorized
• 403 - Forbidden
• 500 - Internal Server Error

// POST /v1/users/:userId/referral-invites
{
  "success": Boolean,
  "error": String,
  "message": null,
  "data": null
}