SenderWiz API
HomepagePricingContact UsLoginSignup
  • Introduction
  • API URL and Key
  • Customer
    • Contact List
      • Get All Lists
      • Get One List
      • Create a List
      • Update a List
      • Copy a List
      • Delete a List
    • Fields
      • Get All List Fields
      • Get One List Field
      • Create a List Field
      • Update a List Field
      • Delete a List Field
      • Get All List Field Types
    • Segments
      • Get All List Segments
      • Get One List Segment
      • Get All Subscribers
      • Create a List Segment
      • Update a List Segment
      • Delete a List Segment
      • Get All List Segment Condition Operators
    • Subscribers
      • Get All Subscribers
      • Get One Subscriber
      • Search Subscriber by Email
      • Search by Email in All Lists
      • Search by Custom Fields in a List
      • Search Subscribers by Status
      • Get Blacklisted Subscribers
      • Get Confirmed Subscribers
      • Get Unconfirmed Subscribers
      • Get Unsubscribed Subscribers
      • Create a Subscriber
      • Create Subscribers in Bulk
      • Update a Subscriber
      • Update a Subscriber by Email
      • Create or Update a Subscriber
      • Unsubscribe a Subscriber
      • Unsubscribe a Subscriber by Email
      • Unsubscribe Subscriber from All Lists
      • Delete One Subscriber
      • Delete Subscriber by Email
    • Campaigns
      • Get All Campaigns
      • Get One Campaign
      • Create a Campaign
      • Update a Campaign
      • Copy a Campaign
      • Pause/Unpause a Campaig
      • Mark a Campaign as SENT
      • Delete a Campaign
      • Get Stats of a Campaign
    • Reports
      • Track Subscriber Click for Campaign
      • Track Subscriber Open
      • Track Subscriber Unsubscribe
    • Bounces
      • Get All Bounces
      • Create a Campaign Bounce
    • Countries
      • Get All Countries
      • Get All Zones of a Country
    • Templates
      • Get All Templates
      • Get One Template
      • Search Templates
      • Create a Template
      • Update a Template
      • Delete a Template
    • Subaccounts
      • Get All Subaccounts
      • Create a Subaccount
      • Update a Subaccount
      • Delete a Subaccount
      • Get Subaccount Permissions
      • Update Subaccount Permissions
    • Transactional Emails
      • Get All Transactional Emails
      • Get One Transactional Email
      • Create a Transactional Email
      • Delete a Transactional Email
  • Admin
    • Customer
      • Get All Customers
      • Get One Customer
      • Create a Customer
      • Update a Customer
      • Delete a Customer
      • Get All Customer Groups
      • Get All Timezones
    • Customer Login via Token
    • Customer Task via Admin API
Powered by GitBook
On this page
  1. Admin
  2. Customer

Create a Customer

Create a new customer account in SenderWiz, with optional company information. This is typically used for provisioning new client accounts.

πŸ‘€ Create a Customer

Use this endpoint to create a customer in SenderWiz. You may also include company details if required.


πŸ”Ή HTTP Request

POST ADMIN-API-URL/customers

πŸ” Authorization Header

X-ADMIN-API-KEY: your-admin-api-key-here

πŸ“ POST Parameters

Parameter
Type
Required
Description

customer

array

Yes

The array with the customer details.

company

array

No

The array with the company details if required by application settings.

🧍 Customer Block

Parameter
Type
Required
Description

first_name

string

Yes

Customer's first name.

last_name

string

Yes

Customer's last name.

email

string

Yes

Customer's email address.

password

string

Yes

Customer's password.

timezone

string

Yes

Timezone (e.g., Asia/Kolkata).

group

string

Yes

Customer's Group Name

birthDate

string

No

Birth date in YYYY-MM-DD format.

parent_uid

string

No

UID of an existing customer account to assign this account as its child.

πŸ’‘ Hint:

  • Customer Groups must be created first in the SenderWiz Admin Panel. Each group controls what a customer can or cannot do β€” such as whether they can create/upload lists, how many contacts they can manage, or how many emails they’re allowed to send, among other settings.

  • πŸ‘‰ Use the Group Name (e.g., "Pro-Group") in the group parameter when creating the customer.

  • 🧩 To make a customer a child account, provide the parent_uid of an existing (non-child) customer account. 🚫 A customer that is already assigned as a child cannot be set as a parent.

🏒 Company Block (Optional)

Parameter
Type
Required
Description

name

string

Yes

Company name.

country

string

Yes

Company country (refer to countries endpoint).

zone

string

Yes

Company zone/state (refer to countries endpoint).

city

string

Yes

Company city.

zip_code

string

Yes

Zip or postal code.

address_1

string

Yes

Main address line 1.

address_2

string

No

Secondary address line 2.


πŸ’» PHP Example

// CREATE CUSTOMER
$response = $endpoint->create([
    'customer' => [
        'first_name' => 'Emma',
        'last_name'  => 'Waters',
        'email'      => 'emma.waters@demo.com',
        'password'   => 'securePass#2025',
        'timezone'   => 'UTC',
        'group'      => 'Pro-Group',
        'birthDate'  => '1988-09-15'
    ],
    // company is optional, unless required from app settings
    'company'  => [
        'name'     => 'Waters Consulting Ltd.',
        'country'  => 'Canada',
        'zone'     => 'Ontario',
        'city'     => 'Toronto',
        'zip_code' => 'M5V3L9',
        'address_1'=> '123 Queen St W',
        'address_2'=> 'Suite 400',
    ],
]);

// DISPLAY RESPONSE
echo '<hr /><pre>';
print_r($response->body);
echo '</pre>';

πŸ“¦ Sample JSON Response

{
  "status": "success",
  "customer_uid": "ab382plq98zr7"
}
PreviousGet One CustomerNextUpdate a Customer

Last updated 1 month ago