Skip to main content
POST
/
v1
/
accounts
Create an Account
curl --request POST \
  --url https://api.sakari.io/v1/accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "plan": {
    "pricing": {},
    "includedPhoneNumberCountries": [
      "<string>"
    ]
  },
  "balance": 123,
  "defaults": {
    "country": {
      "code": "<string>",
      "name": "<string>"
    }
  },
  "promoCode": "<string>",
  "subscription": {
    "activeUntil": "<string>"
  },
  "nextBillingDate": "<string>",
  "trialExpiry": "2023-11-07T05:31:56Z",
  "questionare": {},
  "referrer": "<string>",
  "externalName": "<string>",
  "legalName": "<string>",
  "info": {
    "website": "<string>",
    "phone": "<string>",
    "email": "<string>",
    "address": {
      "line1": "<string>",
      "line2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "country": {
        "code": "<string>",
        "flag": "<string>",
        "dialing": "<string>",
        "name": "<string>",
        "aliass": [
          "<string>"
        ],
        "continent": "<string>",
        "supported": true,
        "alphaNumericSenderId": true,
        "taxTypes": [
          {
            "type": "<string>",
            "name": "<string>",
            "example": "<string>"
          }
        ]
      },
      "postalCode": "<string>"
    }
  },
  "options": {
    "universalMMS": true,
    "verifyNumberType": true,
    "autoLinkShorten": true,
    "autotopup": {
      "amount": 123,
      "below": 123
    },
    "autoEnroll": {
      "domain": "<string>",
      "role": "<string>",
      "notifyEmail": "<string>"
    },
    "customDomain": {
      "id": "<string>",
      "domain": "<string>",
      "renewAt": "<string>",
      "verified": "<string>"
    }
  },
  "integrations": {},
  "partner": {
    "paypalEmail": "<string>",
    "submitted": "2023-11-07T05:31:56Z",
    "approved": "2023-11-07T05:31:56Z",
    "rejected": "2023-11-07T05:31:56Z",
    "contact": "<string>"
  },
  "referralCode": "<string>",
  "questionnaire": {},
  "billing": {
    "name": "<string>",
    "email": "<string>",
    "address": {
      "line1": "<string>",
      "line2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "country": {
        "code": "<string>",
        "flag": "<string>",
        "dialing": "<string>",
        "name": "<string>",
        "aliass": [
          "<string>"
        ],
        "continent": "<string>",
        "supported": true,
        "alphaNumericSenderId": true,
        "taxTypes": [
          {
            "type": "<string>",
            "name": "<string>",
            "example": "<string>"
          }
        ]
      },
      "postalCode": "<string>"
    },
    "tax": {
      "type": "<string>",
      "id": "<string>"
    }
  },
  "created": {
    "at": "2023-11-07T05:31:56Z"
  },
  "suspended": {
    "at": "2023-11-07T05:31:56Z"
  },
  "user": {
    "role": "<string>",
    "segmentUnderstanding": "2023-11-07T05:31:56Z"
  }
}'
"<any>"

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
name
string
required
plan
object
required
defaults
object
required
balance
number
promoCode
string
subscription
object
nextBillingDate
string
trialExpiry
string<date-time>
questionare
object
referrer
string
externalName
string
info
object
options
object
integrations
object
partner
object
referralCode
string
questionnaire
object
billing
object
created
object
suspended
object
user
object

Response

successful operation

The response is of type any.