Wooxy API v.3.0

Find Contact List

The Find Contact List method allows you to obtain information on several lists that belong to a domain.

Important! Minimum one identification (domainId | domain | contactListId) is required.

Important! In this method, pagination is used to display information about a large number of lists simultaneously. The offset is considered the starting point, and the limit is the endpoint.

Request

POST

/v3/contact-list/find

IMPORTANT: Do not send more than 10 concurrent API requests.

Body Example

                                        {
    "domainId":         "YOUR_DOMAIN_ID",
    "domain":           "senderDomain.com",
    "contactListId":    "YOUR_CONTACT_LIST_ID",
    "contactListName":  "Default Contact List",
    "offset":           0,
    "limit":            20
}

Parameters

Title	Type	Default	Description
domainId optional	string		Unique domainId that is already registered in Wooxy system.
domain optional	string		Unique DomainName that is already registered in Wooxy system.
contactListId optional	string		ID of the Contact List where the contact to be updated belongs. The list should be already created in your account on the Lists page: https://app.wooxy.com/email-list
contactListName optional	string		Name of the Contact List. The list should be already created in your account on the Lists page: https://app.wooxy.com/email-list
offset optional	integer	0	Allows you to omit a specified number of rows (number of domains) before the beginning of return rows (events) from the query. The `default` is 0.
limit optional	integer	20	Allows you to limit the number of rows (domains) returned from a query. The `default` is 20.

Response

                                        {
    "result": true,
    "data": [
    {
        "contactListName":  "Default Contact List",
        "contactListId":    "YOUR_FIRST_CONTACT_LIST_ID",
        "domainId":         "YOUR_DOMAIN_ID",
        "domain":           "senderDomain.com",
        "defaultFromEmail": "notify@senderDomain.com",
        "defaultFromName":  "notify@senderDomain.com",
        "company":          "Wooxy",
        "replyToEmail":     "support@senderDomain.com",
        "replyToName":      "Support Team",
        "smsFromName":      "Wooxy",
        "isDefault":        "1",
        "createdAt":        "2020-10-02 12:44:03",
        "updatedAt":        "2020-10-02 12:44:03",
        "customVariables": [
            {
                "name": "companyName",
                "type": "string"
            }
        ],
        "defaultVariables": [
            {
                "name": "createdAt",
                "type": "datetime"
            },
            {
                "name": "email",
                "type": "string"
            },
            {
                "name": "userId",
                "type": "string"
            },
            {
                "name": "name",
                "type": "string"
            },
            {
                "name": "active",
                "type": "bool"
            },
            {
                "name": "phoneNumber",
                "type": "string"
            },
            {
                "name": "emailSubscribe",
                "type": "bool"
            },
            {
                "name": "smsSubscribe",
                "type": "bool"
            },
            {
                "name": "desktopWebPushSubscribe",
                "type": "bool"
            },
            {
                "name": "mobileWebPushSubscribe",
                "type": "bool"
            },
            {
                "name": "telegramSubscribe",
                "type": "bool"
            },
            {
                "name": "customerSourceId",
                "type": "string"
            },
            {
                "name": "sourceName",
                "type": "string"
            },
            {
                "name": "sourceId",
                "type": "string"
            },
            {
                "name": "avatarLink",
                "type": "string"
            },
            {
                "name": "contactBirthday",
                "type": "date"
            },
            {
                "name": "contactLanguage",
                "type": "string"
            },
            {
                "name": "firstName",
                "type": "string"
            },
            {
                "name": "lastName",
                "type": "string"
            },
            {
                "name": "contactGender",
                "type": "string"
            },
            {
                "name": "contactTimezone",
                "type": "string"
            },
            {
                "name": "facebookLink",
                "type": "string"
            },
            {
                "name": "instagramLink",
                "type": "string"
            },
            {
                "name": "linkedInLink",
                "type": "string"
            },
            {
                "name": "twitterLink",
                "type": "string"
            },
            {
                "name": "tiktokLink",
                "type": "string"
            },
            {
                "name": "contactScore",
                "type": "string"
            },
            {
                "name": "cac",
                "type": "array"
            }
        ]
    },
    {
       "contactListId":    "YOUR_SECOND_CONTACT_LIST_ID"
    }
  ],
    "totalCount": 18,
    "offset": 0,
    "limit": 20,
    "errors": []
}

Parameters

Title	Type	Description
result	boolean	Indicated that the query was successful: true: The value indicates that the Contact List data was successfully fetched from your account.
data	array	An array of fetched information.
data.contactListName	string	Name of the Contact List. The list should be already created in your account on the Lists page: https://app.wooxy.com/email-list
data.contactListId	string	ID of the Contact List. The list should be already created in your account on the Lists page: https://app.wooxy.com/email-list
data.domainId	string	Unique domain ID in Wooxy system.
data.domain	string	Verified domain name from your Wooxy account. `IMPORTANT` `default` Contact List data will be returned.
data.defaultFromEmail	string	`default` From_Email address of the Contact List.
data.defaultFromName	string	`default` From_Name of the Contact List.
data.company	string	The official name of your company including incorporation type used for the footer information.
data.replyToEmail	string	`default` Reply-to-Email of the Contact List.
data.replyToName	string	`default` Reply-to-Name of the Contact List.
data.smsFromName	string	`default` SMS From-Name of the Contact List.
data.isDefault	string	Indicates that the Contact List is `default` for the domain: true("1"): Indicates that the Contact List is not `default` for the domain; false("0"): Indicates that the Contact List is `default` for the domain.
data.createdAt	string	Contact List creation time in `YYYY-MM-DD h:i:s format`
data.updatedAt	string	Contact List last updating time in `YYYY-MM-DD h:i:s format`
data.customVariables	array	An array of customer variables from the Contact List.
data.defaultVariables	array	Default system variables from the Contact List. `string` \| `date` \| `datetime` \| `bool` \| `array`
data.defaultVariables.name	string	Name of system variables: createdAt: Contact List creation UTC DateTime; email: Contact’s email address; userId: Contact’s unique user ID from your platform that enables management of the contact in the list based on it; name: The optional display name to use for the recipient; active: Indicates if the contact is enabled Contact List or not; phoneNumber: Contact’s phone number. `IMPORTANT` should be a valid `E.164 phone number` format; emailSubscribe: Indicates if the contact is subscribed to receiving Emails or not; smsSubscribe: Indicates if the contact is subscribed to receiving SMS or not; desktopWebPusSubscribe: Indicates if the contact is subscribed to receiving Desktop Web Push notifications or not; mobileWebPushSubscribe: Indicates if the contact is subscribed to receiving Mobile Web Push notifications or not; telegramSubscribe: Indicates if the contact is subscribed to receiving Telegram messages or not; viberSubscribe: Indicates if the contact is subscribed to receiving Viber messages or not; customerSourceId: Contact’s unique source ID from your system to synchronize two sides; sourceName: Name of your contact acquisition source; sourceId: Contact’s unique source ID from Wooxy platform; avatarLink: Link to contact’s avatar image; contactBirthday: Contact’s birth date in `ENUM_DATE` (YYYY-MM-DD) format; contactLanguage: Contact’s locale in `ISO 639-1 format`; firstName: Contact’s first name; lastName: Contact’s last name; contactGender: Contact’s gender in `ISO/IEC 5218` format; contactTimezone: Contact’s timezone in `ISO 8601` format; facebookLink: Link to contact’s Facebook profile; instagramLink: Link to contact’s Instagram profile; linkedInLink: Link to contact’s LinkedIn profile; twitterLink: Link to contact’s Twitter profile; tiktokLink: Link to contact’s TikTok profile; contactScore: Contact Score; cac: Contact’s customer acquisition cost.
data.defaultVariables.type	string	Type of system variables: string: Type string of default system variable; date: Type the date of the default system variable; datetime: Type the datetime of the default system variable; bool: Type bool of a default system variable; array: Type array of default system variable.
data.totalCount	integer	Total number of fetched Contact Lists.
data.offset	integer	Allows you to omit a specified number of rows (number of templates) before the beginning of return rows (templates) from the query. The `default` is ’20’
data.limit	integer	Allows you to limit the number of rows (Contact Lists) returned from a query. The `default` is ‘0’.

Method Errors

                                        {
  "errors": [
      "Error description text"
  ],
  "result": false
}

Error
“Invalid authorization token!”
“Internal server error”
“Bad Request”
“no matches found for access token {accessToken}”
“user {id} not enabled”
“no data found for key {userId}”
“access token check failed for key/secret $key/$accessToken”
“Argument {argument} required”
“Parameter ‘limit’ must have a numeric value”
“Parameter ‘offset’ must have a numeric value”
“Argument ‘contactListName’ must be a non-empty string”
“Argument ‘contactListId’ must be a non-empty string”
“Argument ‘domain’ must be a non-empty string”
“Argument ‘domainId’ must be a non-empty string”

Code Examples

PHP

                $accessToken = "YOUR_API_KEY";
$url    = 'https://api.wooxy.com/v3/contact-list/find';

$body = json_encode([
   "domainId"        => "YOUR_DOMAIN_ID",
   "domain"          => "senderDomain.com",
   "contactListId"   => "YOUR_CONTACT_LIST_ID",
   "contactListName" => "Default Contact List",
   "offset"          => 0,
   "limit"           => 20,
]);

/**
* Request Example
*/
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_1);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
//curl_setopt($ch, CURLOPT_HEADER, true);
curl_setopt($ch, CURLOPT_INFILESIZE, null);
curl_setopt($ch, CURLOPT_POSTFIELDS, $body);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Access-Token: $accessToken",
    'Content-Type: application/json',
    'Content-Length: ' . strlen($body),
]);

$result = curl_exec($ch);
if ($result === false) {
    echo 'cURL error:' . curl_error($ch) . PHP_EOL;
} else {
    echo strval($result) . PHP_EOL;
}
curl_close($ch);