GET /api/v2/corporate-email-campaigns
List corporate email campaigns


GET /api/v2/corporate-email-campaigns/:id
Show a corporate email campaign

Params

Param name Description
id
required

Corporate Email Campaign ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.


POST /api/v2/corporate-email-campaigns
Create a corporate email campaign

Params

Param name Description
data
required

Corporate email campaign information

Validations:

  • Must be a Hash

data[type]
required

Validations:

data[attributes]
required

Validations:

  • Must be a Hash

data[attributes][title]
required

Validations:

  • Must be a String

data[attributes][subject]
required

Validations:

  • Must be a String

data[attributes][content]
required

Validations:

  • Must be a String

data[attributes][status]
required

Validations:

  • Must be a String

data[relationships]
required

Validations:

  • Must be a Hash

data[relationships][entity]
required

Validations:

  • Must be a Hash

data[relationships][entity][data]
required

Validations:

  • Must be a Hash

data[relationships][entity][data][type]
required

Validations:

data[relationships][entity][data][id]
required

Entity ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.

data[relationships][contact_lists]
required

Validations:

  • Must be an Array of nested elements

data[relationships][contact_lists][data]
required

Validations:

  • Must be an Array of nested elements

data[relationships][contact_lists][data][type]
required

Validations:

data[relationships][contact_lists][data][id]
required

Contact List ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.


PATCH /api/v2/corporate-email-campaigns/:id
Update a corporate email campaign

Params

Param name Description
id
required

Corporate email campaign ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.

data
required

Corporate email campaign information

Validations:

  • Must be a Hash

data[type]
optional

Validations:

data[attributes]
optional

Validations:

  • Must be a Hash

data[attributes][title]
optional

Validations:

  • Must be a String

data[attributes][subject]
optional

Validations:

  • Must be a String

data[attributes][content]
optional

Validations:

  • Must be a String

data[attributes][status]
optional

Validations:

  • Must be a String

data[relationships]
optional

Validations:

  • Must be a Hash

data[relationships][entity]
optional

Validations:

  • Must be a Hash

data[relationships][entity][data]
optional

Validations:

  • Must be a Hash

data[relationships][entity][data][type]
optional

Validations:

data[relationships][entity][data][id]
optional

Entity ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.

data[relationships][contact_lists]
optional

Validations:

  • Must be an Array of nested elements

data[relationships][contact_lists][data]
optional

Validations:

  • Must be an Array of nested elements

data[relationships][contact_lists][data][type]
optional

Validations:

data[relationships][contact_lists][data][id]
optional

Contact List ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.


DELETE /api/v2/corporate-email-campaigns/:id
Delete a corporate email campaign

Params

Param name Description
id
required

Corporate email campaign ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.


GET /api/v2/corporate-email-campaigns/:id/send-test
Send a test email preview

Params

Param name Description
id
required

Corporate email campaign ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.