Create Colleague API

POST `/v1/colleagues-create`

This endpoint is used to create a new colleague entry for potential future invitations. When it is called, it will create a new colleague record in your organization that can later be invited using the Send Invitation API.

Endpoint URL

The endpoint URL is https://api.wazper.com/v1/colleagues-create

HTTP Method

POST

Headers

Header	Type	Required	Description
`X-API-Key`	String	Yes	Your Wazper API Key.
`Content-Type`	String	Yes	Must be `application/json`.
`Accept`	String	No	Recommended `application/json`.

Request Body

The request body must be a JSON object containing colleague information.

{
  "name": "string",
  "email": "string",
  "companyName": "string",
  "toBeInvitedById": "string",
  "jobTitle": "string (optional)",
  "website": "string (optional)",
  "team": "integer (optional)",
  "inviteLink": "string (optional)",
  "redirectionLink": "string (optional)"
}

Request Fields:

Field	Type	Required	Description
`name`	String	Yes	The colleague’s full name.
`email`	String	Yes	The colleague’s email address. This will be used for sending invitations.
`companyName`	String	Yes	The colleague’s company name.
`toBeInvitedById`	String	Yes	The email address of the user who is creating this colleague entry (the inviter).
`jobTitle`	String	No	The colleague’s job title.
`website`	String	No	The colleague’s company website.
`team`	Integer	No	Team identifier or number.
`inviteLink`	String	No	A custom invitation link. If not provided, your organization’s default invite link will be used.
`redirectionLink`	String	No	A custom redirection link for after an invite is accepted. If not provided, the default dashboard link will be used.

Example Request (cURL)

curl -X POST 'https://api.wazper.com/v1/colleagues-create' \
-H 'X-API-Key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
  "name": "Samuel Prospective",
  "email": "[email protected]",
  "companyName": "Innovate Ltd.",
  "toBeInvitedById": "[email protected]",
  "jobTitle": "Marketing Lead",
  "website": "https://innovate.com",
  "team": 2
}'

Success Response (201 Created)

The response contains the newly created colleague entry with all generated fields.

{
  "id": "tbi_xyz789",
  "name": "Samuel Prospective",
  "email": "[email protected]",
  "companyName": "Innovate Ltd.",
  "website": "https://innovate.com",
  "team": 2,
  "wazClientId": "org_abc123xyz",
  "toBeInvitedById": "[email protected]",
  "status": "pending",
  "inviteLink": "https://app.wazper.com/invite",
  "redirectionLink": "https://app.wazper.com/dashboard",
  "jobTitle": "Marketing Lead",
  "latestAction": "2023-10-27T10:00:00.000Z",
  "photo": null,
  "createdAt": "2023-10-27T10:00:00.000Z",
  "updatedAt": "2023-10-27T10:00:00.000Z"
}

Error Responses

400 Bad Request - Missing Required Fields:

{ "error": "Required fields missing: name, email, companyName, and toBeInvitedById are required" }

400 Bad Request - API Key Not Linked:

{ "error": "API Key is not linked to a valid organization." }

401 Unauthorized - API Key Required:
```
{ "error": "API Key is required" }
```

401 Unauthorized - Invalid API Key:

{ "error": "Invalid API Key or key not linked to an organization" }

403 Forbidden - Waz Disabled:

{ "error": "Waz is currently disabled" }

409 Conflict - Duplicate Email:

{ "error": "A colleague with this email ([email protected]) may already exist for this client or inviter." }

500 Internal Server Error:

{ "error": "Internal server error", "details": "The error message from the server." }

Notes

This API does not consume credits from your account.
This API creates a colleague entry that can later be invited using the Send Invitation API.
The colleague’s initial status will be set to “pending”.
If you don’t provide custom invite or redirection links, your organization’s default links will be used.
Each request is logged for tracking and analytics purposes.

Authorizations

X-API-Key

string

header

required

Body

application/json

name

string

required

Full name.

string<email>

required

Email address.

companyName

string

required

Company name.

toBeInvitedById

string<email>

required

Email of the inviter.

jobTitle

string | null

Job title.

website

string<url> | null

Website.

team

integer | null

Team ID.

inviteLink

string<url> | null

Custom invite link.

redirectionLink

string<url> | null

Custom redirection link.

Response

Colleague created successfully.

string

Unique ID of the colleague entry (ToBeInvited table).

name

string

Name of the colleague.

string<email>

Email of the colleague.

jobTitle

string | null

Job title.

status

string

Current status (e.g., pending, invited, joined).

createdAt

string<date-time>

Creation timestamp.

companyName

string

Company name.

website

string<url> | null

Website URL.

inviteLink

string<url> | null

Invite link.

redirectionLink

string<url> | null

Redirection link.

photo

string<url> | null

Photo URL.

team

integer | null

Team identifier.

wazClientId

string

Wazper Client ID.

toBeInvitedById

string<email>

Email of the user who created this entry.

latestAction

string<date-time>

Timestamp of the last action.

updatedAt

string<date-time>

Timestamp of last update.

Introduction

Endpoints

POST `/v1/colleagues-create`

Endpoint URL

HTTP Method

Headers

Request Body

Example Request (cURL)

Success Response (201 Created)

Error Responses

Notes

Authorizations

Body

Response

Introduction

Endpoints

​POST /v1/colleagues-create

​Endpoint URL

​HTTP Method

​Headers

​Request Body

​Example Request (cURL)

​Success Response (201 Created)

​Error Responses

​Notes

Authorizations

Body

Response

POST `/v1/colleagues-create`

Endpoint URL

HTTP Method

Headers

Request Body

Example Request (cURL)

Success Response (201 Created)

Error Responses

Notes