Dealer | PortSIP Knowledge Base

PortSIP Knowledge Base

Retrieve current dealer

get

Get details of current dealer.

Authorizations

Responses

200

application/json

4XX

Error

get

GET /api/dealer HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "enabled": true,
  "level": "DISTRIBUTOR",
  "name": "text",
  "email": "example@example.com",
  "display_name": "text",
  "website": "text",
  "phone": "text",
  "address": "text",
  "description": "text",
  "max_tenants": 1,
  "max_extensions": 1
}

Update current dealer

post

Modify the settings of the current dealer.

Authorizations

Body

emailall ofOptional

The email address of user.

string · max: 128Optional

The email address.

Example: example@example.com

display_namestring · max: 1024Optional

The display name of user.

websitestringOptional

The website of user.

phonestring · max: 32Optional

The mobile phone number of user.

addressstring · max: 128Optional

The address.

descriptionstringOptional

The description of dealer.

Responses

200

4XX

Error

post

POST /api/dealer HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 123

{
  "email": "example@example.com",
  "display_name": "text",
  "website": "text",
  "phone": "text",
  "address": "text",
  "description": "text"
}

No content