Sample code for 30+ languages & platforms
PHP ActiveX Requires Chilkat v11.0.0+

SendGrid: Add or update list contacts and check the import job

See more SendGrid Examples

Use a Marketing Campaigns API key with contact access and the ID of an existing list. A 202 response queues the upsert; it does not confirm that the contacts were saved. Save the job ID and use it to recheck a pending import without submitting the contacts again. The error report may contain contact data; handle it privately.

Add or update contacts ยท Import job status

Chilkat PHP ActiveX Downloads

PHP ActiveX
<?php

$success = 0;

//  Assumes Chilkat is unlocked. See Global Unlock Sample.
$success = 0;
$http = new COM("Chilkat.Http");
$http->RequireSslCertVerify = 1;
//  Supply your API key from protected configuration; AuthToken adds the Bearer prefix.
$http->AuthToken = 'SENDGRID_API_KEY';
$resp = new COM("Chilkat.HttpResponse");

$jobId = '';
if ($jobId == '') {
    $contacts = new COM("Chilkat.JsonObject");
    $contacts->UpdateString('list_ids[0]','YOUR_LIST_UUID');
    $contacts->UpdateString('contacts[0].email','avery@example.com');
    $contacts->UpdateString('contacts[0].first_name','Avery');
    $contacts->UpdateString('contacts[1].email','robin@example.com');
    $contacts->UpdateString('contacts[1].first_name','Robin');
    $success = $http->HttpJson('PUT','https://api.sendgrid.com/v3/marketing/contacts',$contacts,'application/json',$resp);
    if ($success != 1) {
        if ($resp->StatusCode == 0) {
            print $http->LastErrorText . "\n";
        }
        else {
            print 'HTTP ' . $resp->StatusCode . ': ' . $resp->BodyStr . "\n";
        }

        exit;
    }

    if ($resp->StatusCode != 202) {
        print 'HTTP ' . $resp->StatusCode . ': ' . $resp->BodyStr . "\n";
        exit;
    }

    $queued = new COM("Chilkat.JsonObject");
    $success = $queued->Load($resp->BodyStr);
    if ($success != 1) {
        print 'Unexpected response: expected JSON.' . "\n";
        exit;
    }

    if ($queued->HasMember('job_id') != 1) {
        print 'No job ID returned.' . "\n";
        exit;
    }

    $jobId = $queued->stringOf('job_id');
    print 'Save this import job ID: ' . $jobId . "\n";
}

$http->SetUrlVar('job',$jobId);

$success = $http->HttpNoBody('GET','https://api.sendgrid.com/v3/marketing/contacts/imports/{$job}',$resp);
if ($success != 1) {
    if ($resp->StatusCode == 0) {
        print $http->LastErrorText . "\n";
    }
    else {
        print 'HTTP ' . $resp->StatusCode . ': ' . $resp->BodyStr . "\n";
    }

    exit;
}

if ($resp->StatusCode != 200) {
    print 'HTTP ' . $resp->StatusCode . ': ' . $resp->BodyStr . "\n";
    exit;
}

$job = new COM("Chilkat.JsonObject");
$success = $job->Load($resp->BodyStr);
if ($success != 1) {
    print 'Unexpected response: expected JSON.' . "\n";
    exit;
}

$state = $job->stringOf('status');
if ($state == 'pending') {
    print 'Still pending. Check again later with jobId = ' . $jobId . "\n";
    exit;
}

print 'Job status: ' . $state . "\n";
print 'Created: ' . $job->IntOf('results.created_count') . ', updated: ' . $job->IntOf('results.updated_count') . ', errors: ' . $job->IntOf('results.errored_count') . "\n";
if (($state == 'errored') or ($state == 'failed')) {
    print 'Review the job before retrying. If present, results.errors_url identifies the private error report.' . "\n";
}


?>