CharterOpsCharterOps

API reference

Campaigns

List the empty-leg campaigns you sent and read what each one brought back.

List campaigns

GET/v1/campaigns

Scope
read
Quota
Counts toward your allowance

Query parameters

  • from_datedate

  • to_datedate

  • qstring

    Up to 120 characters.

  • sortstring

    Defaults to -sent_at.

    One of-sent_atsent_atroute-routesubject-subjectrecipient_count-recipient_countrequest_count-request_countbooked_cents-booked_cents

  • cursorstring

    Up to 2,000 characters.

  • limitinteger

    From 1 to 100. Defaults to 25.

Response

200 OK

Returns a page of campaign summary objects in items, with next_cursor and total.

Errors

  • 401 Unauthorized
  • 403 Forbidden
  • 404 Not found
  • 409 Conflict
  • 422 Unprocessable content
  • 429 Too many requests

How to handle errors

Example request

curl "$CHARTEROPS_API_URL/v1/campaigns" \
  --header "Authorization: Bearer $CHARTEROPS_API_KEY"

List consented and unsuppressed campaign recipients

GET/v1/campaigns/audience

Scope
read
Quota
Counts toward your allowance

Query parameters

  • cursorstring

    Up to 2,000 characters.

  • limitinteger

    From 1 to 100. Defaults to 25.

  • tagstring

    1 to 32 characters.

Response

200 OK

Returns a page of audience member objects in items, with next_cursor and total.

Errors

  • 401 Unauthorized
  • 403 Forbidden
  • 404 Not found
  • 409 Conflict
  • 422 Unprocessable content
  • 429 Too many requests

How to handle errors

Example request

curl "$CHARTEROPS_API_URL/v1/campaigns/audience" \
  --header "Authorization: Bearer $CHARTEROPS_API_KEY"

Read delivery and booking results for a campaign date range

GET/v1/campaigns/results

Scope
read
Quota
Counts toward your allowance

Query parameters

  • from_datedate

  • to_datedate

Response

200 OK

Returns the campaign results object.

Errors

  • 401 Unauthorized
  • 403 Forbidden
  • 404 Not found
  • 409 Conflict
  • 422 Unprocessable content
  • 429 Too many requests

How to handle errors

Example request

curl "$CHARTEROPS_API_URL/v1/campaigns/results" \
  --header "Authorization: Bearer $CHARTEROPS_API_KEY"

Total what the campaigns sent and brought back

GET/v1/campaigns/summary

Scope
read
Quota
Counts toward your allowance

Response

200 OK

Returns the campaign totals object.

Errors

  • 401 Unauthorized
  • 403 Forbidden
  • 404 Not found
  • 409 Conflict
  • 422 Unprocessable content
  • 429 Too many requests

How to handle errors

Example request

curl "$CHARTEROPS_API_URL/v1/campaigns/summary" \
  --header "Authorization: Bearer $CHARTEROPS_API_KEY"

Read a campaign

GET/v1/campaigns/{id}

Scope
read
Quota
Counts toward your allowance

Path parameters

  • idUUIDRequired

Response

200 OK

Returns the campaign object.

Errors

  • 401 Unauthorized
  • 403 Forbidden
  • 404 Not found
  • 409 Conflict
  • 422 Unprocessable content
  • 429 Too many requests

How to handle errors

Example request

curl "$CHARTEROPS_API_URL/v1/campaigns/$ID" \
  --header "Authorization: Bearer $CHARTEROPS_API_KEY"

Objects

Campaign summary

  • booked_centsinteger

  • booked_countinteger

  • deliveryobject

    10 fields in delivery

    • acceptedinteger

    • complainedinteger

    • deferredinteger

    • deliveredinteger

    • failedinteger

    • knownboolean

    • queuedinteger

    • suppressedinteger

    • unknowninteger

    • unsubscribedinteger

  • empty_leg_idUUID

  • idUUID

  • offerobject

    The leg as the email shows it, with who sends it and from where.

    13 fields in offer

    • aircraft_typeobject

      5 fields in aircraft_type

      • categorystring

        One ofpistonturboproplightmidsizesuper_midsizeheavyultra_long_rangehelicopter

      • icao_designatorstring

      • idUUID

      • manufacturerstring

      • modelstring

    • currencystring

    • fromobject

      10 fields in from

      • citystringCan be null

      • codestring

      • countrystring

      • iatastringCan be null

      • icaostringCan be null

      • idUUID

      • latitudenumber

      • longitudenumber

      • namestring

      • timezonestringCan be null

    • logoobjectCan be null

      The logo as stored: the whole picture, with the size a page needs to hold its place.

      3 fields in logo

      • heightinteger

      • urlstring

      • widthinteger

    • mailing_addressstringCan be null

    • organization_namestring

    • price_centsintegerCan be null

    • responsibilitystring

    • seatsintegerCan be null

    • timezonestring

    • toobject

      10 fields in to

      • citystringCan be null

      • codestring

      • countrystring

      • iatastringCan be null

      • icaostringCan be null

      • idUUID

      • latitudenumber

      • longitudenumber

      • namestring

      • timezonestringCan be null

    • window_enddate-time

    • window_startdate-time

  • recipient_countinteger

  • request_countinteger

  • senderobjectCan be null

    4 fields in sender

    • domainstring

    • from_emailstring

    • reply_tostring

    • sender_namestring

  • sending_statusstring

  • sent_atdate-time

  • sent_byobjectCan be null

    3 fields in sent_by

    • avatar_urlstringCan be null

    • display_namestring

    • user_idUUIDCan be null

  • stop_reasonstringCan be null

  • subjectstring

Audience member

  • companystringCan be null

  • emailstring

  • idUUID

  • namestring

Campaign results

  • booked_centsinteger

  • booked_countinteger

  • campaignsinteger

  • deliveryobject

    10 fields in delivery

    • acceptedinteger

    • complainedinteger

    • deferredinteger

    • deliveredinteger

    • failedinteger

    • knownboolean

    • queuedinteger

    • suppressedinteger

    • unknowninteger

    • unsubscribedinteger

  • requestsinteger

Campaign totals

  • booked_centsinteger

  • campaignsinteger

  • emailsinteger

  • requestsinteger

Campaign

  • booked_centsinteger

  • booked_countinteger

  • deliveryobject

    10 fields in delivery

    • acceptedinteger

    • complainedinteger

    • deferredinteger

    • deliveredinteger

    • failedinteger

    • knownboolean

    • queuedinteger

    • suppressedinteger

    • unknowninteger

    • unsubscribedinteger

  • emailobject

    The email line by line, so a screen can draw exactly what is sent without its HTML.

    9 fields in email

    • buttonstring

    • factsarray of objects

      2 fields in facts

      • labelstring

      • valuestring

    • headingstring

    • logoobjectCan be null

      The logo as stored: the whole picture, with the size a page needs to hold its place.

      3 fields in logo

      • heightinteger

      • urlstring

      • widthinteger

    • responsibilitystring

    • senderstring

    • sentencestring

    • signaturestring

    • subjectstring

  • empty_leg_idUUID

  • idUUID

  • notestringCan be null

  • offerobject

    The leg as the email shows it, with who sends it and from where.

    13 fields in offer

    • aircraft_typeobject

      5 fields in aircraft_type

      • categorystring

        One ofpistonturboproplightmidsizesuper_midsizeheavyultra_long_rangehelicopter

      • icao_designatorstring

      • idUUID

      • manufacturerstring

      • modelstring

    • currencystring

    • fromobject

      10 fields in from

      • citystringCan be null

      • codestring

      • countrystring

      • iatastringCan be null

      • icaostringCan be null

      • idUUID

      • latitudenumber

      • longitudenumber

      • namestring

      • timezonestringCan be null

    • logoobjectCan be null

      The logo as stored: the whole picture, with the size a page needs to hold its place.

      3 fields in logo

      • heightinteger

      • urlstring

      • widthinteger

    • mailing_addressstringCan be null

    • organization_namestring

    • price_centsintegerCan be null

    • responsibilitystring

    • seatsintegerCan be null

    • timezonestring

    • toobject

      10 fields in to

      • citystringCan be null

      • codestring

      • countrystring

      • iatastringCan be null

      • icaostringCan be null

      • idUUID

      • latitudenumber

      • longitudenumber

      • namestring

      • timezonestringCan be null

    • window_enddate-time

    • window_startdate-time

  • recipient_countinteger

  • request_countinteger

  • requestsarray of objects

    4 fields in requests

    • clientobjectCan be null

      4 fields in client

      • companystringCan be null

      • idUUID

      • namestring

      • timezonestring

    • created_atdate-time

    • idUUID

    • statusstring

      One ofopenquotedbookedcompleteddeclinedcancelled

  • senderobjectCan be null

    4 fields in sender

    • domainstring

    • from_emailstring

    • reply_tostring

    • sender_namestring

  • sending_statusstring

  • sent_atdate-time

  • sent_byobjectCan be null

    3 fields in sent_by

    • avatar_urlstringCan be null

    • display_namestring

    • user_idUUIDCan be null

  • stop_reasonstringCan be null

  • subjectstring

  • tagstringCan be null