Audiences
Jede Operation in dieser Gruppe: was sie annimmt, was sie zurückgibt und mit welchen Fehlern sie antworten kann.
Operationen
A named list of contacts in this workspace. Every contact is in the built-in default audience from the moment it exists, and builtin is what names that row; the rest are yours to make, fill and delete.
Send to one or more audiences with POST /broadcasts. A contact who unsubscribes from a broadcast stays in the audience with unsubscribedAt set, and later broadcasts to it skip them. Deleting an audience drops its memberships and leaves every contact in the book.
GET/audiences
List audiences
The built-in default audience comes first, then the rest newest first, one page at a time. contactCount on each row is counted at the moment of the read, so two reads either side of a create disagree by one.
The default audience is resolved on the first read, so a workspace that has never made an audience still lists exactly one row.
Requires the audiences:read scope.
Query-Parameter
limitintegerRows per page, 1 to 100.
Mindestens 1Höchstens 100Standard25cursorstringAn audience id. Keyset, not offset: pass the previous page's
nextCursor. One that names nothing in this list is a 400invalid_cursor.
Rückgabe
A page of the audiences in this workspace.
Fehler
Die Fehler, die jede Operation zurückgeben kann400401403404422500Fehlerkatalog
Auch verfügbar über
POST/audiences
Create an audience
Makes an empty audience. name is trimmed and names are not checked for duplicates, because an audience is addressed by its id.
builtin is never accepted from the body: exactly one row per workspace carries it and the server owns that row.
Requires the audiences:write scope.
Request-Body
namestringErforderlichDisplay name, trimmed, 1 to 120 characters. Not unique.
1 bis 120 ZeichendescriptionstringWhat the audience is for. Leave it out to create the audience without one.
Kann null seinBis zu 1000 Zeichen
Rückgabe
Created.
Fehler
- 422
workspace_limit_reachedwhen the workspace already holds the most audiences it may have.
Die Fehler, die jede Operation zurückgeben kann400401403404500Fehlerkatalog
Auch verfügbar über
GET/audiences/growth
How audiences grew over a window
The numbers behind the growth chart on the Audiences page, in one request: for each audience, how many contacts it holds now, how many of those joined before the window, and when the rest joined, bucketed by grain.
An audience records the date each contact joined it and never the date one left. A series therefore counts the contacts still in the list today by the date they joined, and it never falls: a contact who joined inside the window and was later removed does not appear in it at all.
totals.contacts counts each person once. totals.memberships adds the lists up, and the default audience holds every contact, so a person counts once for every list they are in.
Requires the audiences:read scope.
Query-Parameter
audienceIdsstringComma separated audience ids, at most 50. Leave it out to read every audience in the workspace, the default one included. A repeated id counts once.
Bis zu 4000 ZeichendaysintegerHow far back to look. The window starts at the beginning of its first bucket in the offset you asked for, so the oldest bucket is a whole one, and ends now, so the newest is partial.
Mindestens 1Höchstens 1095Standard30minutesintegerThe window in minutes, which wins over
dayswhen both are sent. Use it with anhourorminutegrain to watch an import land.Mindestens 1Höchstens 1576800grainstringHow wide one bucket is, and the shape of its key:
YYYY-MM-DDfor a day,YYYY-MM-DDTHHfor an hour,YYYY-MM-DDTHH:MMfor a minute.Einer von"minute""hour""day"Standard"day"offsetMinutesintegerMinutes east of UTC to cut the buckets in, so a day breaks where the reader's day does rather than at midnight UTC.
Mindestens -840Höchstens 840Standard0
Rückgabe
The window and one series per audience. Buckets are sparse.
Fehler
- 404
audience_not_foundonaudienceIdswhen an id names no audience in this workspace. Nothing is read.- 422
invalid_parameteronaudienceIdsfor more than 50 ids, ondays,minutesoroffsetMinutesout of range, or on an unknowngrain.
Die Fehler, die jede Operation zurückgeben kann400401403500Fehlerkatalog
Auch verfügbar über
GET/audiences/{id}
Retrieve an audience
The same shape as the list row, with a fresh contactCount. This is the cheap way to watch a count move without pulling the contacts behind it. An audience in another workspace is a 404, never a 403.
Requires the audiences:read scope.
Pfadparameter
idstringErforderlichAudience id such as
aud_9f2c4b7e1a0d63d84c5f2e7b.
Rückgabe
The audience.
Fehler
Die Fehler, die jede Operation zurückgeben kann400401403404422500Fehlerkatalog
Auch verfügbar über
PATCH/audiences/{id}
Update an audience
A partial update. The built-in default audience can be renamed and described like any other, and renaming it changes neither builtin nor what it holds. Membership is untouched here.
Requires the audiences:write scope.
Pfadparameter
idstringErforderlichAudience id such as
aud_9f2c4b7e1a0d63d84c5f2e7b.
Request-Body
namestringNew display name, trimmed, 1 to 120 characters.
1 bis 120 ZeichendescriptionstringNew description. Null clears it.
Kann null seinBis zu 1000 Zeichen
Rückgabe
Saved.
Fehler
Die Fehler, die jede Operation zurückgeben kann400401403404422500Fehlerkatalog
Auch verfügbar über
DELETE/audiences/{id}
Delete an audience
Deletes the audience and its memberships. The contacts themselves stay in the book, in the default audience, and in any other audience they were in.
Requires the audiences:write scope.
Pfadparameter
idstringErforderlichAudience id such as
aud_9f2c4b7e1a0d63d84c5f2e7b. Not the default audience.
Rückgabe
Deleted.
Fehler
- 403
The key lacks the scope, or may not send as that address.
step_up_required: the call was made with an OAuth access token that has not been verified in the last 60 minutes. Ask for a code withPOST /security/step-up, send it toPOST /security/step-up/verify, then repeat the call. The person can also choose Allow changes for 60 minutes on the app in Account settings, Connected apps, on the OpenEmail website. An API key is never asked for a code.- 409
audience_immutable: the built-in default audience cannot be deleted.
Die Fehler, die jede Operation zurückgeben kann400401404422500Fehlerkatalog
Auch verfügbar über
GET/audiences/{id}/contacts
List an audience's contacts
The contacts themselves rather than membership records, one page at a time, each with addedAt, the date it joined this audience. Every contact in the audience is reachable by following nextCursor, which makes this the way to export an audience. Reading the built-in default audience here returns the whole address book.
audiences:read is the only scope checked, so a key with it reads the addresses in an audience without holding contacts:read.
Requires the audiences:read scope.
Pfadparameter
idstringErforderlichAudience id such as
aud_9f2c4b7e1a0d63d84c5f2e7b.
Query-Parameter
limitintegerRows per page, 1 to 200.
Mindestens 1Höchstens 200Standard50cursorstringThe previous page's
nextCursor, never built by hand. Send the sameq,sourceandsortwith it. Keyset, not offset: pass the previous page'snextCursor. One that names nothing in this list is a 400invalid_cursor.qstringNarrows the page to contacts whose name or address matches. When nothing in the audience matches exactly, the search allows for a typo instead, and later pages of the same query keep to the same kind of match.
Bis zu 200 ZeichensourcestringNarrows the page to contacts recorded that way.
Einer von"manual""auto""form"sortstringlast-heard-newestputs the contacts most recently written to first and those never written to last, the order ofGET /contacts.last-heard-oldestreverses it.added-newestandadded-oldestorder byaddedAt, the date each contact joined this audience.nameis alphabetical without case, and a contact with no name sorts by its address.Einer von"last-heard-newest""last-heard-oldest""added-newest""added-oldest""name"Standard"last-heard-newest"statusstring[]Comma-separated.
subscribedkeeps the members who have not unsubscribed,unsubscribedkeeps the ones who have. Leave it out, or name both, for everyone in the audience.Einer von"subscribed""unsubscribed"
Rückgabe
A page of the contacts in this audience.
Fehler
- 400
invalid_cursorwhencursornames no contact in this audience.- 404
audience_not_foundwhen the id names no audience in this workspace.- 422
invalid_parameteron an unknownsort,sourceorstatus, alimitout of range or aqover 200 characters.
Die Fehler, die jede Operation zurückgeben kann401403500Fehlerkatalog
Auch verfügbar über
POST/audiences/{id}/contacts
Add a contact to an audience
Takes an address already in the workspace book. Adding one that is already in the audience changes nothing, answers 200 and carries the original addedAt, so a retry is safe.
An address that is not a contact is refused rather than created on the spot. Save it with POST /contacts first. To add many contacts in one call, use POST /audiences/{id}/contacts/batch.
Requires the audiences:write scope.
Pfadparameter
idstringErforderlichAudience id such as
aud_9f2c4b7e1a0d63d84c5f2e7b.
Request-Body
emailstringErforderlichAn address already in the workspace book. An unknown address is refused rather than created on the spot.
Bis zu 320 ZeichenFormatemail
Rückgabe
The membership, with the contact it points at.
Fehler
- 422
contact_not_foundonemailwhen that address is not in the workspace book.
Die Fehler, die jede Operation zurückgeben kann400401403404500Fehlerkatalog
Auch verfügbar über
DELETE/audiences/{id}/contacts/{email}
Remove a contact from an audience
Removes the membership. The contact stays in the book, stays in the default audience and stays in every other audience it was in. A contact that is not in this audience is a 404, so a typo cannot report a removal that never happened.
Requires the audiences:write scope.
Pfadparameter
idstringErforderlichAudience id such as
aud_9f2c4b7e1a0d63d84c5f2e7b. Not the default audience.emailstringErforderlichThe contact's address, matched case insensitively.
Rückgabe
Removed.
Fehler
- 404
audience_not_foundfor theid,contact_not_foundonemailwhen that address is not in the workspace book, oraudience_member_not_foundwhen the contact exists but is not in this audience.- 409
audience_immutable: the built-in default audience holds every contact for as long as it is a contact. Delete the contact to take it out.
Die Fehler, die jede Operation zurückgeben kann400401403422500Fehlerkatalog
Auch verfügbar über
POST/audiences/{id}/contacts/batch
Add many contacts to an audience
Puts up to 200 existing contacts in the audience in one call, in one transaction. It never creates a contact: an address that is not in the workspace book comes back in missing and the rest are still added. To create contacts as you add them, use POST /audiences/{id}/import.
A contact already in the audience is counted in unchanged and keeps its original addedAt, so the call is safe to replay. Adding to the built-in default audience answers added: 0, because every contact is in it already.
Requires the audiences:write scope.
Pfadparameter
idstringErforderlichAudience id such as
aud_9f2c4b7e1a0d63d84c5f2e7b.
Request-Body
emailsstring[]Erforderlich1 to 200 addresses. Each is trimmed and lower cased and a repeat counts once. They are looked up in the workspace book as they stand, so an address that is not a contact comes back in
missingrather than refusing the call.1 bis 200 Einträge
Rückgabe
What the call added, what was there already and what is not a contact.
Fehler
- 404
audience_not_foundwhen the id names no audience in this workspace.- 422
invalid_parameteronemailswhen it is empty or holds more than 200 addresses, and on the entry, such asemails.2, when an address is empty or too long,unknown_parameterfor any other key in the body.
Die Fehler, die jede Operation zurückgeben kann400401403500Fehlerkatalog
Auch verfügbar über
POST/audiences/{id}/contacts/batch-remove
Remove many contacts from an audience
Takes up to 200 contacts out of the audience in one call, in one transaction. The contacts stay in the book, in the default audience and in every other audience they are in.
Nothing is refused for one address: a contact that is not in this audience comes back in notInAudience and an address that is not a contact in missing, and the rest are still removed. A replay therefore succeeds and reports the contacts the first call removed under notInAudience.
Requires the audiences:write scope.
Pfadparameter
idstringErforderlichAudience id such as
aud_9f2c4b7e1a0d63d84c5f2e7b. Not the default audience.
Request-Body
emailsstring[]Erforderlich1 to 200 addresses. Each is trimmed and lower cased and a repeat counts once. They are looked up in the workspace book as they stand, so an address that is not a contact comes back in
missingrather than refusing the call.1 bis 200 Einträge
Rückgabe
What the call removed, what was not in the audience and what is not a contact.
Fehler
- 404
audience_not_foundwhen the id names no audience in this workspace.- 409
audience_immutable: the built-in default audience holds every contact for as long as it is a contact. Delete the contacts to take them out.- 422
invalid_parameteronemailswhen it is empty or holds more than 200 addresses, and on the entry, such asemails.2, when an address is empty or too long,unknown_parameterfor any other key in the body.
Die Fehler, die jede Operation zurückgeben kann400401403500Fehlerkatalog
Auch verfügbar über
POST/audiences/{id}/import
Import contacts into an audience
What the CSV import on an audience page does, without the file: up to 500 rows of an address and an optional name, in one transaction. An address that is not a contact yet is saved as one, with source set to manual, and joins the default audience too. An address that is a contact already is reused as it stands and keeps its name: a name sent here only fills one that is empty. Every imported contact ends up in this audience.
A row whose address is not well formed is skipped and returned in invalid, and the other rows are still imported. Importing an address whose contact was deleted brings it back. Replaying the same rows creates nothing twice, so the call is safe to retry. Send a longer list in several calls.
Requires the audiences:write and contacts:write scopes.
Pfadparameter
idstringErforderlichAudience id such as
aud_9f2c4b7e1a0d63d84c5f2e7b. The default audience is accepted and saves the contacts without putting them in any other list.
Request-Body
contactsobject[]Erforderlich1 to 500 rows. Send a longer list in several calls. Rows with the same address, compared without case, count as one.
1 bis 500 EinträgeemailstringErforderlichTrimmed and lower cased. A row whose address is not well formed is skipped and listed in
invalid, and the other rows are still imported.1 bis 320 ZeichennamestringTrimmed. Used for a new contact, or for an existing one whose name is empty. A name already saved is kept.
Kann null seinBis zu 200 Zeichen
Rückgabe
What the import created, added and skipped.
Fehler
- 403
insufficient_scopeunless the key holds bothaudiences:writeandcontacts:write.- 404
audience_not_foundwhen the id names no audience in this workspace.- 422
invalid_parameteroncontactswhen it is empty or holds more than 500 rows, or on a row whoseemailis empty or longer than 320 characters or whosenameis longer than 200,unknown_parameterfor any other key.
Die Fehler, die jede Operation zurückgeben kann400401500Fehlerkatalog
Auch verfügbar über
POST/audiences/{id}/empty
Empty an audience
Takes every contact out of the audience in one transaction and answers with the audience as it now stands, contactCount 0, plus removed, the number of contacts taken out. The audience itself stays, with its name and id, and so does every contact: each one stays in the book, in the default audience and in its other audiences. No body.
There is no undo, so check the audience id before you call this.
Requires the audiences:write scope.
Pfadparameter
idstringErforderlichAudience id such as
aud_9f2c4b7e1a0d63d84c5f2e7b. Not the default audience.
Rückgabe
The audience, now empty.
objectstring- Einer von
"audience" idstringThe durable handle,
aud_plus 24 hex.namestringdescriptionstring- Kann null sein
builtinstringWhich built-in audience this row is:
defaultfor the one every contact joins, null for one somebody created. Branch on this rather than on the name, which anybody can change.Kann null seinEiner von"default"contactCountintegerCounted at the moment of the read, never cached.
lastContactAtstringWhen the contact who joined most recently joined this audience, read at the moment of the request. Null while the audience is empty.
Kann null seinFormatdate-timecreatedAtstring- Format
date-time updatedAtstring- Format
date-time removedintegerContacts taken out of the audience. 0 when it was empty already.
Fehler
- 404
audience_not_foundwhen the id names no audience in this workspace.- 409
audience_immutable: the built-in default audience holds every contact for as long as it is a contact, so it cannot be emptied.
Die Fehler, die jede Operation zurückgeben kann400401403422500Fehlerkatalog
Auch verfügbar über
Objekte
Audienceobject
objectstring- Einer von
"audience" idstringThe durable handle,
aud_plus 24 hex.namestringdescriptionstring- Kann null sein
builtinstringWhich built-in audience this row is:
defaultfor the one every contact joins, null for one somebody created. Branch on this rather than on the name, which anybody can change.Kann null seinEiner von"default"contactCountintegerCounted at the moment of the read, never cached.
lastContactAtstringWhen the contact who joined most recently joined this audience, read at the moment of the request. Null while the audience is empty.
Kann null seinFormatdate-timecreatedAtstring- Format
date-time updatedAtstring- Format
date-time
AudienceBatchAddobject
objectstring- Einer von
"audience_batch" audienceIdstringaddedintegerContacts that joined the audience in this call.
unchangedintegerContacts that were in the audience already. Their
addedAtis kept.missingstring[]The addresses that are not contacts in this workspace, trimmed, lower cased and listed once each. Nothing is created for them. Save them with
POST /contacts, or usePOST /audiences/{id}/import, which creates contacts as it goes.
AudienceBatchRemoveobject
objectstring- Einer von
"audience_batch" audienceIdstringremovedintegerContacts taken out of the audience in this call.
notInAudiencestring[]Addresses of contacts that exist but were not in this audience, so there was nothing to remove for them.
missingstring[]The addresses that are not contacts in this workspace, trimmed, lower cased and listed once each. Nothing is created for them. Save them with
POST /contacts, or usePOST /audiences/{id}/import, which creates contacts as it goes.
AudienceContactobject
objectstring- Einer von
"contact" emailstringTrimmed and lower cased on write. This is the key every contact route takes, because no contact id is exposed.
namestring- Kann null sein
sourcestringautowhen a send from the app composer recorded the address,manualwhen somebody saved it here or in the app. A recorded send never downgrades amanualcontact toauto.Einer von"manual""auto""form"notesstring- Kann null sein
photoUrlstringWhere the contact photo is served, or null when the contact has none. Set it with
PUT /contacts/{email}/photo. A new upload gets a new URL.Kann null seinlastSeenAtstringWhen mail last went to this address from the app composer. Null until it does.
Kann null seinFormatdate-timecreatedAtstring- Format
date-time updatedAtstring- Format
date-time addedAtstringWhen the contact joined this audience. The
added-newestandadded-oldestsorts order by it, and a repeated add keeps the original date.Formatdate-timeunsubscribedAtstringWhen the contact followed the unsubscribe link in a broadcast sent to this audience, or null while it is subscribed. An unsubscribed contact stays in the audience and in the book, and broadcasts to this audience skip it. Removing it from the audience and adding it back makes a fresh, subscribed membership. Mail sent to it one message at a time is not affected.
Kann null seinFormatdate-time
AudienceContactListobject
objectstring- Einer von
"list" hasMorebooleannextCursorstring- Kann null sein
audienceIdstring
AudienceGrowthobject
objectstring- Einer von
"audience_growth" sincestringThe start of the window, floored to the start of its first bucket in the local time of
offsetMinutes.Formatdate-timeuntilstringThe end of the window, which is the moment of the read.
Formatdate-timegrainstring- Einer von
"minute""hour""day" offsetMinutesintegerThe offset the buckets were cut in, as sent or 0.
totalsobjectcontactsintegerDistinct contacts across the audiences read, each counted once however many of them it is in.
subscribedintegerOf those, the contacts still subscribed to at least one of the audiences read, so a broadcast to them would reach them.
membershipsintegerThe series
totalvalues added up. The default audience holds every contact, so a contact in two other audiences counts three times here.addedintegerJoins inside the window across every series.
unsubscribedintegerUnsubscribes inside the window across every series.
listsintegerHow many audiences were read.
busieststringThe bucket key with the most joins across every series, the earliest one on a tie, or null when nobody joined in the window.
Kann null sein
seriesobject[]One per audience read, the largest first and then by name.
idstringThe audience id.
namestringbuiltinbooleanTrue for the default audience, the one that holds every contact. A boolean here, where the audience object carries the
builtinkind.totalintegerContacts in the audience now.
subscribedintegerOf those, the contacts still subscribed. The rest unsubscribed and are skipped by broadcasts.
beforeintegerOf those, the contacts that joined before
since.addedintegerOf those, the contacts that joined inside the window. With
beforeit makes uptotal.unsubscribedintegerContacts that unsubscribed from the audience inside the window.
bucketsobject[]SPARSE, oldest first. Only buckets in which somebody joined or unsubscribed are listed, so a chart has to fill the gaps with zero itself.
bucketstringThe bucket's key in the local time of
offsetMinutes:YYYY-MM-DDfor a day,YYYY-MM-DDTHHfor an hour,YYYY-MM-DDTHH:MMfor a minute.addedintegerContacts that joined the audience in that bucket and are still in it.
unsubscribedintegerContacts that unsubscribed from the audience in that bucket, through a broadcast unsubscribe link.
AudienceImportobject
objectstring- Einer von
"audience_import" audienceIdstringcreatedintegerAddresses that were not contacts yet and were saved as new ones, with
sourceset tomanual.addedintegerContacts that joined this audience in this call, new and existing together. A contact already in it is not counted.
skippedintegerRows that were not imported because the address is not well formed.
invalidstring[]The addresses of the skipped rows, exactly as they were sent.
AudienceListobject
objectstring- Einer von
"list" dataAudience[]hasMorebooleannextCursorstring- Kann null sein
AudienceMemberobject
objectstring- Einer von
"audience_member" audienceIdstringaddedAtstringWhen the contact first joined this audience. A repeat add answers with the original date rather than a new one.
Formatdate-timecontactContact
Contactobject
objectstring- Einer von
"contact" emailstringTrimmed and lower cased on write. This is the key every contact route takes, because no contact id is exposed.
namestring- Kann null sein
sourcestringautowhen a send from the app composer recorded the address,manualwhen somebody saved it here or in the app. A recorded send never downgrades amanualcontact toauto.Einer von"manual""auto""form"notesstring- Kann null sein
photoUrlstringWhere the contact photo is served, or null when the contact has none. Set it with
PUT /contacts/{email}/photo. A new upload gets a new URL.Kann null seinlastSeenAtstringWhen mail last went to this address from the app composer. Null until it does.
Kann null seinFormatdate-timecreatedAtstring- Format
date-time updatedAtstring- Format
date-time