Update Colleague API

​

PATCH /v1/colleagues-update

​

Endpoint URL

​

HTTP Method

​

Headers

​

Request Body

{
  "id": "string",
  "status": "string (optional)",
  "email": "string (optional)"
}

​

Example Request (cURL)

curl -X PATCH 'https://api.wazper.com/v1/colleagues-update' \
-H 'X-API-Key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
  "id": "tbi_xyz789",
  "status": "invited"
}'

​

Success Response (200 OK)

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

​

Error Responses

• 400 Bad Request - Missing Required Fields:
  Copy

  { "error": "Required fields missing: id and either status or email are required" }
  
• 400 Bad Request - Invalid Email Format:
  Copy

  { "error": "Invalid email format" }
  
• 401 Unauthorized - API Key Required:
  Copy

  { "error": "API Key is required" }
  
• 401 Unauthorized - Invalid API Key:
  Copy

  { "error": "Invalid API Key or key not linked to an organization" }
  
• 403 Forbidden - Waz Disabled:
  Copy

  { "error": "Waz is currently disabled" }
  
• 404 Not Found - Colleague Not Found:
  Copy

  { "error": "Colleague with ID tbi_nonexistent not found for client org_abc123xyz." }
  
• 409 Conflict - Duplicate Email:
  Copy

  { "error": "A colleague with the new email ([email protected]) may already exist." }
  
• 500 Internal Server Error:
  Copy

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

​

Notes

• This API does not consume credits from your account.
• You must provide either a status or email field to update, or both.
• The latestAction timestamp is automatically updated when any field is modified.
• When updating the email, it must be in a valid email format.