Invite Users to Company

Invite users to a company

post

Invites one or more users to join a company using their email addresses.

Body

application/json

company_idintegerRequired

The ID of the company to which users are being invited.

Example: 385

emailstring · emailOptional

The email address of the user to invite. Use this field for a single invitation.

Example: [email protected]

emailsstring · email[]Optional

An array of email addresses to invite. Use this field for multiple invitations.

Example: [email protected]

Responses

200

Invitation success response

application/json

post

/company/invite

HTTPcURLJavaScriptPython

POST /company/invite HTTP/1.1
Host: api.taag.co
Content-Type: application/json
Accept: */*
Content-Length: 75

{
  "company_id": 385,
  "email": "[email protected]",
  "emails": [
    "[email protected]"
  ]
}

200

Invitation success response

{
  "status": "success"
}

Re-invite users to a company

post

Re-invites users to a company based on their profile IDs. If the user does not exist, a new user is created and invited.

Body

application/json

company_idintegerRequired

The ID of the company to which users are being re-invited.

Example: 385

profile_idsinteger[]Required

An array of profile IDs representing the users to be re-invited.

Example: 12345

Responses

200

Re-invitation success response

application/json

post

/company/reinvite

HTTPcURLJavaScriptPython

POST /company/reinvite HTTP/1.1
Host: api.taag.co
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "company_id": 385,
  "profile_ids": [
    12345
  ]
}

200

Re-invitation success response

{
  "status": "success",
  "no_users": [
    "John Doe"
  ]
}