Customer Token API

create new entry

POST /api/rest/admin/customer-tokens

Parameters

Name	Description
data[type]	Resource type (customer-tokens)
data[attributes][allowed-ips]	Allowed ips
data[attributes][customer-portal-access-profile-id]	Customer portal access profile id
data[relationships][customer]	Customer
data[relationships][accounts]	Accounts
data[relationships][allow-outgoing-numberlists]	Allow outgoing numberlists
data[relationships][provision-gateway]	Provision gateway

Request

Headers

Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOjc0LCJhdWQiOlsiYWRtaW4iXSwiZXhwIjoxNzcyMjEyMDAyfQ.JDQ7zY19-bBE1_SazQDxT02EWBsw1iB4Aqby9uob2t4
Host: example.org
Cookie: 

Route

POST /api/rest/admin/customer-tokens

Body

{"data":{"type":"customer-tokens","attributes":{"allowed-ips":["10.20.30.40","11.12.13.14"],"customer-portal-access-profile-id":7},"relationships":{"customer":{"data":{"type":"contractors","id":42}},"accounts":{"data":[{"type":"accounts","id":46},{"type":"accounts","id":47}]},"allow-outgoing-numberlists":{"data":[{"type":"numberlists","id":2},{"type":"numberlists","id":3}]},"provision-gateway":{"data":{"type":"gateways","id":22}}}}}

Response

Headers

x-frame-options: SAMEORIGIN
x-xss-protection: 0
x-content-type-options: nosniff
x-permitted-cross-domain-policies: none
referrer-policy: strict-origin-when-cross-origin
content-type: application/vnd.api+json
location: http://example.org/api/rest/admin/customer-tokens/42
vary: Accept
etag: W/"e7351329f6e5f9a1f68c79ebd3a498b1"
cache-control: max-age=0, private, must-revalidate
x-request-id: 24d28b81-0828-4845-8d23-7d76802dd5b4
x-runtime: 0.012385
content-length: 574

Status

201 Created

Body

{
  "data": {
    "id": "42",
    "type": "customer-tokens",
    "links": {
      "self": "http://example.org/api/rest/admin/customer-tokens/42"
    },
    "attributes": {
      "token": "eyJhbGciOiJIUzI1NiJ9.eyJhdWQiOlsiY3VzdG9tZXItdjEiXSwic3ViIjoiRCIsImNmZyI6eyJjdXN0b21lcl9pZCI6NDIsImN1c3RvbWVyX3BvcnRhbF9hY2Nlc3NfcHJvZmlsZV9pZCI6NywiYWNjb3VudF9pZHMiOls0Niw0N10sImFsbG93X291dGdvaW5nX251bWJlcmxpc3RzX2lkcyI6WzIsM10sImFsbG93ZWRfaXBzIjpbIjEwLjIwLjMwLjQwIiwiMTEuMTIuMTMuMTQiXSwicHJvdmlzaW9uX2dhdGV3YXlfaWQiOjIyfSwiZXhwIjoxNzcyMjEyMDAyfQ.eHK_M-KwPOS1Mtf6Pbd3Kk98V8AFXJCvjbtT--qiZ3g",
      "expires-at": "2026-02-27T17:06:42.608Z"
    }
  }
}