ANangelcam
client

Creates new client account

Creates a new client account. After successful creation client receives an email with link for account activation.

post/clients/

Request

  • Base URL
    https://api.angelcam.com/v1
  • Auth
    • OAuth 2
      Authorization codehttps://my.angelcam.com/oauth/authorize/, token URL https://my.angelcam.com/oauth/token/
      PasswordToken URL https://api.angelcam.com/oauth/token/
      Scopesclient_create
    • or API key in header Authorization
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Request body

first_namestring required

Clients first name

last_namestring required

Clients last name

emailstring email required

Clients email

phonestring

Clients phone number

invoice_to'me' | 'client'

All services are invoice to reseller (me) or directly to client.

limited_accountboolean

Limited clients cannot connect new cameras or purchase any services, by themselves.

allowed_accessboolean

This option can be used to give away access to the client user account. A client action is required in order to get the access again.

activatedboolean

Create the client account as already activated (i.e. do not send the activation email). A special permission is required for the reseller account in order to use this option.

passwordstring

Create the client account with a given default password. A special permission is required for the reseller account in order to use this option.

Example request

{
  "first_name": "Joe",
  "last_name": "Parker",
  "email": "joe@angelcam.com",
  "phone": "+1 111 222 333",
  "invoice_to": "me",
  "limited_account": false
}

Response

Newly created client object

idinteger required

Client ID

first_namestring required

Clients first name

last_namestring required

Clients last name

emailstring email required

Clients email

phonestring nullable required

Clients phone number

invoice_to'me' | 'client' required

All services are invoice to reseller (me) or directly to client.

limited_accountboolean required

Limited clients cannot connect new cameras or purchase any services, by themselves.

allowed_accessboolean required

This field indicates if reseller can access clients cameras. Defualt is true, but client can refuse access.

activated_atstring datetime nullable required

Datetime, when client activated their account, or null in a case when the account is not activated yet at all.

Example response

{
  "id": 42,
  "first_name": "Joe",
  "last_name": "Parker",
  "email": "joe@angelcam.com",
  "phone": "+1 111 222 333",
  "invoice_to": "client",
  "limited_account": false,
  "allowed_access": true,
  "confiremd_at": null
}

Changes

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