Skip to content
Pidgely Docs

API reference · Audiences (legacy)

Create a contact in an audience

POSThttps://api.pidgely.com/audiences/{id}/contacts
View as Markdown

Creates (or updates) the contact and adds it to the audience (segment).

Authorization: Bearer pdg_…. An API key with full_access. A sending_access key gets 401 restricted_api_key.

Path parameters

Name Type Required Description
id string Yes Resource id UUID.

Body parameters

JSON object.

Name Type Required Description
email string No Email address.
first_name string No First name, up to 200 characters. Available as {{{FIRST_NAME}}} in broadcasts.
last_name string No Last name, up to 200 characters. Available as {{{LAST_NAME}}} in broadcasts.
unsubscribed boolean No Whether the contact opted out of broadcasts. Kept in sync with the suppression list.
properties object (map of string | number | boolean | null) No Custom properties: up to 100 keys matching ^[A-Za-z_][A-Za-z0-9_]{0,49}$, values string (up to 2,000 characters), number, boolean, or null to delete.
segments object[] No Segments to add the contact to.
segments[].id string Yes Segment id. UUID.
topics any[] No Not supported yet.

Request

Node.js
import { Pidgely } from 'pidgely';

const pidgely = new Pidgely(process.env.PIDGELY_API_KEY);

const { data, error } = await pidgely.contacts.create({
  audienceId: '0199d7f5-9a3e-7d4b-a1c2-7e5f0b3d6c48',
  email: 'steve@example.com',
  firstName: 'Steve',
  unsubscribed: false,
});
console.log(data ?? error);
Python
import os
import pidgely

pidgely.api_key = os.environ["PIDGELY_API_KEY"]

result = pidgely.Contacts.create({
    "audience_id": "0199d7f5-9a3e-7d4b-a1c2-7e5f0b3d6c48",
    "email": "steve@example.com",
    "first_name": "Steve",
    "unsubscribed": False,
})
print(result)
PHP
<?php

require __DIR__ . '/vendor/autoload.php';

$pidgely = Pidgely::client(getenv('PIDGELY_API_KEY'));

$result = $pidgely->contacts->create([
    'audience_id' => '0199d7f5-9a3e-7d4b-a1c2-7e5f0b3d6c48',
    'email' => 'steve@example.com',
    'first_name' => 'Steve',
    'unsubscribed' => false,
]);
var_dump($result);
Go
package main

import (
	"context"
	"fmt"
	"os"

	"github.com/pidgely/pidgely-go"
)

func main() {
	ctx := context.Background()
	client := pidgely.NewClient(os.Getenv("PIDGELY_API_KEY"))

	result, err := client.Contacts.Create(ctx, &pidgely.CreateContactRequest{
		Email:        "steve@example.com",
		FirstName:    "Steve",
		Unsubscribed: pidgely.Bool(false),
		AudienceId:   "0199d7f5-9a3e-7d4b-a1c2-7e5f0b3d6c48",
	})
	if err != nil {
		panic(err)
	}
	fmt.Println(result)
}
Ruby
require "pidgely"

Pidgely.api_key = ENV["PIDGELY_API_KEY"]

result = Pidgely::Contacts.create({
  audience_id: "0199d7f5-9a3e-7d4b-a1c2-7e5f0b3d6c48",
  email: "steve@example.com",
  first_name: "Steve",
  unsubscribed: false
})
puts result
cURL
curl -X POST 'https://api.pidgely.com/audiences/0199d7f5-9a3e-7d4b-a1c2-7e5f0b3d6c48/contacts' \
  -H "Authorization: Bearer $PIDGELY_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "email": "steve@example.com",
  "first_name": "Steve",
  "unsubscribed": false
}'

Response

200 OK

JSON
{
  "object": "contact",
  "id": "0199d7f4-5d7b-7a2c-b4e1-9f3c2a6d8e05"
}

Response fields

Name Type Required Description
object string Yes Object type.
id string Yes Unique id (UUID). UUID.

Errors

Errors have the shape {"statusCode", "name", "message"}. See Errors for the full list.

Status Name When
401 missing_api_key, restricted_api_key No Authorization: Bearer header, or a sending_access key called an endpoint that needs full_access.
403 invalid_api_key, validation_error The API key is invalid or revoked, or the request is not allowed for this account (unverified domain, plan limit, paused account).
404 not_found The resource does not exist in this account (or the id is not a valid UUID).
422 validation_error A field is missing or invalid; message names it.
429 rate_limit_exceeded Too many requests per second. Wait for Retry-After seconds.