SegmentingContactsListSegments500Response
{
"type": "object",
"required": [
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"required": [
"message"
],
"properties": {
"message": {
"type": "string"
}
}
}
}
}
}
SegmentingContactsListSegmentsResponse
{
"type": "object",
"required": [
"results"
],
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/segment_summary"
},
"minItems": 0,
"uniqueItems": true
}
}
}
SegmentingContactsUpdateSegmentById500Response
{
"type": "object",
"required": [
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"required": [
"message"
],
"properties": {
"message": {
"type": "string"
}
}
}
}
}
}
SegmentingContactsUpdateSegmentByIdResponse
{
"type": "object",
"required": [
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"required": [
"message",
"field"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
}
}
}
SendTestEmailToContactsRequest
{
"type": "object",
"example": {
"emails": [
"janedoe@example.com",
"tiramisu@example.com",
"bundt@example.com"
],
"sender_id": 6060664,
"template_id": "f8f77db8-b9fa-4b3c-9ee8-de3d582016b8",
"version_id_override": "7734f757-8eb8-4d22-b7f0-779a72f32986",
"suppression_group_id": 21865513,
"custom_unsubscribe_url": "https://example.com/unsubscribe"
},
"required": [
"template_id",
"emails"
],
"properties": {
"emails": {
"type": "array",
"items": {
"type": "string",
"format": "email"
},
"maxItems": 10,
"minItems": 1,
"description": "An array of email addresses you want to send the test message to.",
"uniqueItems": true
},
"sender_id": {
"type": "integer",
"description": "This ID must belong to a verified sender. Alternatively, you may supply a `from_address` email."
},
"template_id": {
"type": "string",
"format": "uuid",
"description": "The ID of the template that you would like to use. If you use a template that contains a subject and content (either text or HTML), then those values specified at the personalizations or message level will not be used."
},
"from_address": {
"type": "string",
"format": "email",
"description": "You can either specify this address or specify a verified sender ID."
},
"version_id_override": {
"type": "string",
"format": "uuid",
"description": " You can override the active template with an alternative template version by passing the version ID in this field. If this field is blank, the active template version will be used."
},
"suppression_group_id": {
"type": "integer"
},
"custom_unsubscribe_url": {
"type": "string",
"description": "A custom unsubscribe URL."
}
}
}
SendTestEmailToContactsResponse
{
"type": "object",
"example": {},
"properties": {}
}
SenderIdentitiesApiDeleteSenderIdentity403Response
{
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
}
}
}
SenderIdentitiesApiDeleteSenderIdentity404Response
{
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
}
}
}
SenderIdentitiesApiDeleteSenderIdentityResponse
{
"type": "object",
"properties": {}
}
SenderIdentitiesApiGetAllResponse
{
"type": "object",
"properties": {
"result": {
"type": "array",
"items": {
"$ref": "#/components/schemas/senderID"
}
}
}
}
SenderIdentitiesApiResendVerificationEmail400Response
{
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
}
}
}
SenderIdentitiesApiResendVerificationEmail404Response
{
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
}
}
}
SenderIdentitiesApiResendVerificationEmailResponse
{
"type": "object",
"properties": {}
}
SenderIdentitiesApiUpdateSenderIdentity403Response
{
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
}
}
}
SenderIdentitiesApiUpdateSenderIdentity404Response
{
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
}
}
}
SenderIdentitiesApiUpdateSenderIdentityResponse
{
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
}
}
}
SenderIdentitiesApiViewSenderIdentityResponse
{
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
}
}
}
SenderVerificationCreateVerifiedSenderRequestResponse
{
"type": "object",
"required": [
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"required": [
"message",
"error_id"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
},
"error_id": {
"type": "string"
}
}
}
}
}
}
SenderVerificationDeleteVerifiedSender403Response
{
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"required": [
"message",
"error_id"
],
"properties": {
"message": {
"type": "string"
},
"error_id": {
"type": "string"
}
}
}
}
}
}
SenderVerificationDeleteVerifiedSender404Response
{
"type": "object",
"required": [
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"required": [
"message",
"error_id"
],
"properties": {
"message": {
"type": "string"
},
"error_id": {
"type": "string"
}
}
}
}
}
}
SenderVerificationDeleteVerifiedSenderResponse
{
"type": "object",
"example": {},
"properties": {}
}
SenderVerificationDetermineVerificationStatusResponse
{
"type": "object",
"properties": {
"results": {
"type": "object",
"properties": {
"domain_verified": {
"type": "boolean"
},
"sender_verified": {
"type": "boolean"
}
}
}
}
}
SenderVerificationGetAllSenderIdentitiesResponse
{
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/verified-sender-response-schema"
}
}
}
}
SenderVerificationListDomainWarnResponse
{
"type": "object",
"required": [
"results"
],
"properties": {
"results": {
"type": "object",
"required": [
"soft_failures",
"hard_failures"
],
"properties": {
"hard_failures": {
"type": "array",
"items": {
"type": "string"
}
},
"soft_failures": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
SenderVerificationRequestVerificationTokenResponse
{
"type": "object",
"required": [
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"required": [
"message",
"error_id"
],
"properties": {
"message": {
"type": "string"
},
"error_id": {
"type": "string"
}
}
}
}
}
}
SenderVerificationResendVerificationEmail400Response
{
"type": "object",
"required": [
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"required": [
"message",
"error_id"
],
"properties": {
"message": {
"type": "string"
},
"error_id": {
"type": "string"
}
}
}
}
}
}
SenderVerificationResendVerificationEmail404Response
{
"type": "object",
"required": [
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"required": [
"message",
"error_id"
],
"properties": {
"message": {
"type": "string"
},
"error_id": {
"type": "string"
}
}
}
}
}
}
SenderVerificationResendVerificationEmailResponse
{
"type": "object",
"example": {},
"properties": {}
}
SenderVerificationUpdateSenderIdentity403Response
{
"type": "object",
"required": [
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"required": [
"message",
"error_id"
],
"properties": {
"message": {
"type": "string"
},
"error_id": {
"type": "string"
}
}
}
}
}
}
SenderVerificationUpdateSenderIdentity404Response
{
"type": "object",
"required": [
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"required": [
"message",
"error_id"
],
"properties": {
"message": {
"type": "string"
},
"error_id": {
"type": "string"
}
}
}
}
}
}
SenderVerificationUpdateSenderIdentityResponse
{
"type": "object",
"required": [
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"required": [
"message",
"error_id"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
},
"error_id": {
"type": "string"
}
}
}
}
}
}
SendersCreateIdentityRequest
{
"type": "object",
"example": {
"zip": "94105",
"city": "San Francisco",
"from": {
"name": "Example Orders",
"email": "orders@example.com"
},
"state": "CA",
"address": "1234 Fake St.",
"country": "United States",
"nickname": "Example Orders",
"reply_to": {
"name": "Example Support",
"email": "support@example.com"
},
"address_2": ""
},
"required": [
"nickname",
"from",
"address",
"city",
"country"
],
"properties": {
"zip": {
"type": "string",
"description": "The zipcode of the sender identity."
},
"city": {
"type": "string",
"description": "The city of the sender identity."
},
"from": {
"type": "object",
"required": [
"email",
"name"
],
"properties": {
"name": {
"type": "string",
"description": "This is the name appended to the from email field. IE - Your name or company name."
},
"email": {
"type": "string",
"description": "This is where the email will appear to originate from for your recipient"
}
}
},
"state": {
"type": "string",
"description": "The state of the sender identity."
},
"address": {
"type": "string",
"description": "The physical address of the sender identity."
},
"country": {
"type": "string",
"description": "The country of the sender identity."
},
"nickname": {
"type": "string",
"description": "A nickname for the sender identity. Not used for sending."
},
"reply_to": {
"type": "object",
"required": [
"email"
],
"properties": {
"name": {
"type": "string",
"description": "This is the name appended to the reply to email field. IE - Your name or company name."
},
"email": {
"type": "string",
"description": "This is the email that your recipient will reply to."
}
}
},
"address_2": {
"type": "string",
"description": "Additional sender identity address information."
}
}
}
SettingsInboundParseDeleteSettingByHostnameResponse
{
"type": "object",
"example": {},
"properties": {}
}
SettingsMailGetAllMailSettings400Response
{
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"required": [
"message"
],
"properties": {
"field": {
"type": "string",
"nullable": true,
"description": "The field that generated the error."
},
"message": {
"type": "string",
"description": "The error message."
},
"error_id": {
"type": "string",
"description": "The ID associated with the error."
},
"parameter": {
"type": "string"
}
}
}
}
}
}
SettingsMailGetAllMailSettings401Response
{
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"required": [
"message"
],
"properties": {
"field": {
"type": "string",
"nullable": true,
"description": "The field that generated the error."
},
"message": {
"type": "string",
"description": "The error message."
},
"error_id": {
"type": "string",
"description": "The ID associated with the error."
},
"parameter": {
"type": "string"
}
}
}
}
}
}
SettingsMailGetAllMailSettings403Response
{
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"required": [
"message"
],
"properties": {
"field": {
"type": "string",
"nullable": true,
"description": "The field that generated the error."
},
"message": {
"type": "string",
"description": "The error message."
},
"error_id": {
"type": "string",
"description": "The ID associated with the error."
},
"parameter": {
"type": "string"
}
}
}
}
}
}
SettingsMailGetAllMailSettings404Response
{
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"required": [
"message"
],
"properties": {
"field": {
"type": "string",
"nullable": true,
"description": "The field that generated the error."
},
"message": {
"type": "string",
"description": "The error message."
},
"error_id": {
"type": "string",
"description": "The ID associated with the error."
},
"parameter": {
"type": "string"
}
}
}
}
}
}
SettingsMailGetAllMailSettings500Response
{
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"required": [
"message"
],
"properties": {
"field": {
"type": "string",
"nullable": true,
"description": "The field that generated the error."
},
"message": {
"type": "string",
"description": "The error message."
},
"error_id": {
"type": "string",
"description": "The ID associated with the error."
},
"parameter": {
"type": "string"
}
}
}
}
}
}
SettingsMailGetAllMailSettingsResponse
{
"type": "object",
"required": [
"result"
],
"properties": {
"result": {
"type": "array",
"items": {
"type": "object",
"required": [
"title",
"enabled",
"name",
"description"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the mail setting."
},
"title": {
"type": "string",
"description": "The title of the mail setting."
},
"enabled": {
"type": "boolean",
"description": "Indicates if this mail setting is currently enabled."
},
"description": {
"type": "string",
"description": "A description of the mail setting."
}
}
},
"description": "The list of all mail settings."
}
}
}
SettingsMailUpdateAddressWhitelistMailSettingsRequest
{
"type": "object",
"example": {
"list": [
"email1@example.com",
"example.com"
],
"enabled": true
},
"properties": {
"list": {
"type": "array",
"items": {
"type": "string"
},
"description": "Either a single email address that you want whitelisted or a domain, for which all email addresses belonging to this domain will be whitelisted."
},
"enabled": {
"type": "boolean",
"description": "Indicates if your email address whitelist is enabled."
}
}
}
SettingsMailUpdateLegacyTemplateSettingsRequest
{
"type": "object",
"example": {
"enabled": true,
"html_content": "<% body %>"
},
"properties": {
"enabled": {
"type": "boolean",
"description": "Indicates if you want to enable the legacy email template mail setting."
},
"html_content": {
"type": "string",
"description": "The new HTML content for your legacy email template."
}
}
}
SettingsMailUpdateLegacyTemplateSettingsResponse
{
"type": "object",
"required": [
"enabled",
"html_content"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Indicates if the legacy email template mail setting is enabled."
},
"html_content": {
"type": "string",
"description": "The HTML content of your legacy email template."
}
}
}
SettingsPartnerListPartnerSettingsResponse
{
"type": "object",
"properties": {
"result": {
"type": "array",
"items": {
"type": "object",
"required": [
"title",
"enabled",
"name",
"description"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the partner setting."
},
"title": {
"type": "string",
"description": "The title of the partner."
},
"enabled": {
"type": "boolean",
"description": "Indicates if this partner setting has been enabled."
},
"description": {
"type": "string",
"description": "A description of this partner setting."
}
}
}
}
}
}
SettingsPartnerUpdateNewRelicPartnerSettingsRequest
{
"type": "object",
"example": {
"enabled": true,
"license_key": "",
"enable_subuser_statistics": true
},
"properties": {
"enabled": {
"type": "boolean",
"description": "Indicates if this partner setting is enabled."
},
"license_key": {
"type": "string",
"description": "The license key for your New Relic account."
},
"enable_subuser_statistics": {
"type": "boolean",
"description": "Indicates if your subuser statistics will be sent to your New Relic Dashboard."
}
}
}
SettingsTrackingGetAllTrackingResponse
{
"type": "object",
"properties": {
"result": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the event being tracked."
},
"title": {
"type": "string",
"description": "The title of the tracking setting."
},
"enabled": {
"type": "boolean",
"description": "Indicates if this tracking setting is currently enabled."
},
"description": {
"type": "string",
"description": "A description about the event that is being tracked."
}
}
},
"description": "The list of all tracking settings."
}
}
}
SettingsTrackingGetOpenSettingsResponse
{
"type": "object",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Indicates if open tracking is enabled."
}
}
}
SettingsTrackingUpdateClickTrackingSettingRequest
{
"type": "object",
"example": {
"enabled": true
},
"properties": {
"enabled": {
"type": "boolean",
"description": "The setting you want to use for click tracking."
}
}
}
SettingsTrackingUpdateOpenTrackingSettingsRequest
{
"type": "object",
"example": {
"enabled": true
},
"properties": {
"enabled": {
"type": "boolean",
"description": "The new status that you want to set for open tracking."
}
}
}
SettingsTrackingUpdateOpenTrackingSettingsResponse
{
"type": "object",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Indicates if open tracking is enabled."
}
}
}
SingleSendsBulkDelete500Response
{
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
},
"error_id": {
"type": "string"
}
}
}
}
}
}