TEtelgea
Users

Create a new user

Creates a new user in your organization. Use this endpoint to onboard employees or contractors who need mobile numbers or telecommunications resources.

Once created, the user can be assigned to teams, associated with billing entities, and provisioned with SIM cards through the user-plans endpoint.

post/v1/users

Request

  • Base URL
    https://api.telgea.com
  • Auth
    API key in header x-api-key

Headers

idempotency-keystring

A value unique to this request, of 1 to 255 printable ASCII characters — a UUID is the usual choice. Retry with the same key within 24 hours and you get the original response back, even if it was a failure, and nothing is done twice. Send a new key whenever you change the request. Keys are private to your API key and organisation.

Example:0b7e4f1c-6a2d-4c9e-8f35-d1a7b2c93e60

Request body

emailstring email required

Email address of the new user. Unique within your organization.

firstNamestring required

First name

lastNamestring required

Last name

teamIdstring uuid

Team to assign the user to. Omitted, the user joins the default team, Unassigned.

costCodestring

Cost center code for billing purposes

employeeIdstring

External employee identifier

Example request

{
  "email": "anna.holm@acme.example",
  "firstName": "Anna",
  "lastName": "Holm",
  "teamId": "2f6b0d3a-8c1e-4a7f-9b2d-1e3c4d5f6a70",
  "costCode": "CC-4100",
  "employeeId": "EMP-0142"
}

Response

User created successfully. Returns the created user object including the auto-generated user ID.

idstring required

UUID of the created user. Use it to provision a plan, submit a port-in, or update the user.

emailstring email required

Email address as stored.

firstNamestring required

First name as stored.

lastNamestring required

Last name as stored.

Example response

{
  "id": "9c1f2a6e-3b7d-4e0a-8f21-5d6c7b8a9e01",
  "email": "anna.holm@acme.example",
  "firstName": "Anna",
  "lastName": "Holm"
}

Changes

No recorded changes to this operation across all 1 revision of this API.