Create Delivery account

POST/api/delivery/accounts

Creates a Delivery account and optionally creates the customer billing profile/order.

Authorization

api_key

X-Api-Token<token>

API token used to authenticate requests.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

description*string

Delivery account description.

type*string

Delivery account type.

transactional = transactional SMTP/API sending.
newsletter = marketing/newsletter sending.

Values transactional | newsletter

payment_method?string

Payment method for paid plans.

stripe = Stripe payment method.
lcwsoftpaypalbillingagreements = PayPal billing agreement payment method.
paypal = PayPal payment method.

Values stripe | lcwsoftpaypalbillingagreements | paypal

customer_code?string

Customer code that will own the account. Admin only.

ignore_suppression_list?boolean

Ignore Delivery suppression list checks for this account.

allow_nets?string[]

Allowed IP addresses or networks for SMTP/API access.

customer_type?string

Customer billing profile type when a WHMCS profile must be created.

private = private individual billing profile.
company = company billing profile.
reseller = reseller billing profile.

Values private | company | reseller

firstname?string

Billing profile first name.

lastname?string

Billing profile last name.

email_address?string

Billing profile email address.

country?string

Billing profile country.

address1?string

Billing profile address.

city?string

Billing profile city.

postcode?string

Billing profile postal code.

state?string

Billing profile state/province.

phonenumber?string

Billing profile phone number.

password2?string

Billing profile password.

password2_confirmation?string

Billing profile password confirmation.

fiscalcode?string

Billing profile fiscal code.

vat?string

Billing profile VAT number.

companyname?string

Billing profile company name.

Response Body

`application/json`

curl -X POST "https://example.com/api/delivery/accounts" \  -H "X-Api-Token: YOUR_API_TOKEN" \  -H "Accept: application/json" \  -H "Content-Type: application/json" \  -d '{    "description": "string",    "type": "transactional"  }'

{
  "resources": [
    {
      "created_at": "string",
      "updated_at": "string",
      "username": "string",
      "description": "string",
      "id": "string",
      "status": 0,
      "status_detail": "ok",
      "type": "transactional",
      "plan": "free",
      "start_date": "string",
      "num_messages": "string",
      "password": "string",
      "config_hostname": "string",
      "customer_code": "string",
      "customer_fullname": "string",
      "domains_count": "string",
      "allow_nets": "string",
      "domains": "string",
      "bounce_notification": "string",
      "bounce_notification_to_sender": "string",
      "next_renewal_date": "string",
      "last_renewal_date": "string",
      "plan_expiration_date": "string",
      "remaining_messages": "string",
      "messages_sent": "string",
      "remaining_extra_messages_bought": "string",
      "extra_messages_total": "string",
      "remaining_messages_error": "string",
      "extra_messages_expires_at": "string",
      "delivery_analytics": "string",
      "has_pending_order": "string",
      "delete_on": "string",
      "plan_num_messages": "string",
      "reset_to_plan_num_messages": "string",
      "manager_fullname": "string",
      "manager_code": "string",
      "ignore_suppression_list": "string"
    }
  ],
  "pagination": {}
}

{
  "message": "Unauthorized",
  "errors": []
}

{
  "message": "Forbidden",
  "errors": []
}

{
  "message": "Not found",
  "errors": []
}

{
  "message": "Validation failed",
  "errors": [
    {
      "field": "name",
      "description": "is not valid"
    }
  ]
}

Create Delivery account

Authorization

Request Body

Response Body

200application/json

401application/json

403application/json

404application/json

422application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`