Export links code examples (JavaScript & PHP)

Ready-to-use samples for export survey links. Replace:

https://api-cxm.akwad.sa - Base url
{collector_uuid} - Collector ID from Collect → API → Details
{your_token} - External access token

TIP

See Export responses for HTTP status codes and error shapes.

JavaScript

const apiBase = 'https://api-cxm.akwad.sa';
const collectorUuid = '{collector_uuid}';
const token = '{your_token}';

async function exportSurveyLinks() {
  const response = await fetch(
    `${apiBase}/api/v1/collectors/api/${collectorUuid}/export`,
    {
      method: 'POST',
      headers: {
        'Content-Type': 'application/json',
        Accept: 'application/json',
        'Accept-Language': 'en',
        'X-External-Access-Token': token,
      },
      body: JSON.stringify({
        recipients: [
          {
            email: 'john1@example.com',
            phone: '+966501234567',
            first_name: 'John',
            last_name: 'Doe',
            variables: { request_number: 'REQ-88421' },
          },
        ],
      }),
    },
  );

  const payload = await response.json();

  if (!response.ok) {
    console.error(payload.message, payload.errors);
    throw new Error(payload.message ?? 'Export request failed');
  }

  return payload.data;
}

exportSurveyLinks()
  .then((data) => {
    for (const row of data.recipients) {
      console.log(row.status, row.survey_link, row.error);
    }
  })
  .catch((error) => console.error(error));

PHP

php

<?php

$apiBase = 'https://api-cxm.akwad.sa';
$collectorUuid = '{collector_uuid}';
$token = '{your_token}';

$url = rtrim($apiBase, '/').'/api/v1/collectors/api/'.$collectorUuid.'/export';

$body = json_encode([
    'recipients' => [
        [
            'email' => 'john1@example.com',
            'phone' => '+966501234567',
            'first_name' => 'John',
            'last_name' => 'Doe',
            'variables' => ['request_number' => 'REQ-88421'],
        ],
    ],
], JSON_THROW_ON_ERROR);

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Content-Type: application/json',
        'Accept: application/json',
        'Accept-Language: en',
        'X-External-Access-Token: '.$token,
    ],
    CURLOPT_POSTFIELDS => $body,
]);

$responseBody = curl_exec($ch);
$statusCode = (int) curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

$payload = json_decode($responseBody, true, 512, JSON_THROW_ON_ERROR);

if ($statusCode < 200 || $statusCode >= 300) {
    throw new RuntimeException($payload['message'] ?? 'Export request failed');
}

foreach ($payload['data']['recipients'] as $row) {
    echo ($row['status'] ?? '').' '.($row['survey_link'] ?? '').PHP_EOL;
}

← Export responses

Export links code examples (JavaScript & PHP) ​

JavaScript ​

PHP ​

Export links code examples (JavaScript & PHP)

JavaScript

PHP