Mail Chimp Account

Mail Chimp Account Documentation

Mail Chimp Account [POST]

Mail Chimp Account [POST]

Request

Endpoint

POST /api/v2/account_lists/8134aef6-1d02-45c1-89fc-674d12cdce40/mail_chimp_account
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "mail_chimp_accounts",
    "attributes": {
      "api_key": "fake-us4",
      "updated_in_db_at": "2022-01-12 17:18:42 UTC"
    }
  }
}

Parameters

Attributes

api_key

Type Unknown

Description Valid MailChimp API key

Required No

created_at

Type date

Description The timestamp of when this resource was created

Required No

primary_list_id

Type Unknown

Description MailChimp list to sync newsletter contacts with

Required No

updated_at

Type date

Description The timestamp of when this resource was last updated

Required No

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

Required No

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
201 Created

Body

{
  "data": {
    "id": "9e76d03d-c433-429c-b2a9-806156bb9080",
    "type": "mail_chimp_accounts",
    "attributes": {
      "active": false,
      "auto_log_campaigns": true,
      "created_at": "2022-01-12T17:18:42Z",
      "lists_available_for_newsletters": [

      ],
      "lists_link": "https://us4.admin.mailchimp.com/lists/",
      "lists_present": false,
      "primary_list_id": null,
      "primary_list_name": null,
      "updated_at": "2022-01-12T17:18:42Z",
      "updated_in_db_at": "2022-01-12T17:18:42Z",
      "valid": false,
      "validate_key": null,
      "validation_error": null
    }
  }
}

Fields

Attributes

active

Type boolean

Description Active Account or Not

auto_log_campaigns

Type boolean

Description Auto Log Campaigns or Not

created_at

Type date

Description The timestamp of when this resource was created

lists_available_for_newsletters

Type ["Mail Chimp List"]

Description Lists available for newsletters

lists_link

Type string

Description Lists Link

lists_present

Type boolean

Description Lists Present or Not

primary_list_id

Type string

Description Primary List ID

primary_list_name

Type string

Description Primary List Name

updated_at

Type date

Description The timestamp of when this resource was last updated

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

valid

Type boolean

Description Valid

validate_key

Type boolean

Description Validate Key or Not

validation_error

Type string

Description Validation Error

Mail Chimp Account [GET]

Mail Chimp Account [GET]

Request

Endpoint

GET /api/v2/account_lists/02767b66-e49c-4304-b9ec-29a874d538a0/mail_chimp_account
Content-Type: application/vnd.api+json

Body

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

{
  "data": {
    "id": "4be9cd2a-fc72-4ddd-93ba-b4be26f1f574",
    "type": "mail_chimp_accounts",
    "attributes": {
      "active": false,
      "auto_log_campaigns": false,
      "created_at": "2022-01-12T17:18:43Z",
      "lists_available_for_newsletters": [

      ],
      "lists_link": "https://us4.admin.mailchimp.com/lists/",
      "lists_present": false,
      "primary_list_id": "1e72b58b72",
      "primary_list_name": null,
      "updated_at": "2022-01-12T17:18:43Z",
      "updated_in_db_at": "2022-01-12T17:18:43Z",
      "valid": false,
      "validate_key": null,
      "validation_error": null
    }
  }
}

Fields

Attributes

active

Type boolean

Description Active Account or Not

auto_log_campaigns

Type boolean

Description Auto Log Campaigns or Not

created_at

Type date

Description The timestamp of when this resource was created

lists_available_for_newsletters

Type ["Mail Chimp List"]

Description Lists available for newsletters

lists_link

Type string

Description Lists Link

lists_present

Type boolean

Description Lists Present or Not

primary_list_id

Type string

Description Primary List ID

primary_list_name

Type string

Description Primary List Name

updated_at

Type date

Description The timestamp of when this resource was last updated

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

valid

Type boolean

Description Valid

validate_key

Type boolean

Description Validate Key or Not

validation_error

Type string

Description Validation Error

Mail Chimp Account [PUT]

Mail Chimp Account [PUT]

Request

Endpoint

PUT /api/v2/account_lists/ccb557ec-304a-4e64-bf93-334a4958132b/mail_chimp_account
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "mail_chimp_accounts",
    "attributes": {
      "api_key": "fake-us4",
      "updated_in_db_at": "2022-01-12 17:18:43 UTC"
    }
  }
}

Parameters

Attributes

api_key

Type Unknown

Description Valid MailChimp API key

Required No

created_at

Type date

Description The timestamp of when this resource was created

Required No

overwrite

Type boolean

Description Only used for updating a record where you want to ignore the server's ' 'updated_in_db_at value and force overwrite the values for the record. ' 'Must be true to work.

Required No

primary_list_id

Type Unknown

Description MailChimp list to sync newsletter contacts with

Required No

updated_at

Type date

Description The timestamp of when this resource was last updated

Required No

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

Required No

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

{
  "data": {
    "id": "de36e0c4-592b-4043-8217-e0d83c37347b",
    "type": "mail_chimp_accounts",
    "attributes": {
      "active": false,
      "auto_log_campaigns": false,
      "created_at": "2022-01-12T17:18:43Z",
      "lists_available_for_newsletters": [

      ],
      "lists_link": "https://us4.admin.mailchimp.com/lists/",
      "lists_present": false,
      "primary_list_id": "1e72b58b72",
      "primary_list_name": null,
      "updated_at": "2022-01-12T17:18:43Z",
      "updated_in_db_at": "2022-01-12T17:18:43Z",
      "valid": false,
      "validate_key": null,
      "validation_error": null
    }
  }
}

Fields

Attributes

active

Type boolean

Description Active Account or Not

auto_log_campaigns

Type boolean

Description Auto Log Campaigns or Not

created_at

Type date

Description The timestamp of when this resource was created

lists_available_for_newsletters

Type ["Mail Chimp List"]

Description Lists available for newsletters

lists_link

Type string

Description Lists Link

lists_present

Type boolean

Description Lists Present or Not

primary_list_id

Type string

Description Primary List ID

primary_list_name

Type string

Description Primary List Name

updated_at

Type date

Description The timestamp of when this resource was last updated

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

valid

Type boolean

Description Valid

validate_key

Type boolean

Description Validate Key or Not

validation_error

Type string

Description Validation Error

Mail Chimp Account [DELETE]

Mail Chimp Account [DELETE]

Request

Endpoint

DELETE /api/v2/account_lists/f0c8e1ee-e754-4131-8f53-dcb89a4bc33c/mail_chimp_account
Content-Type: application/vnd.api+json

Body

Response

Headers

204 No Content

Body

Mail Chimp Account [SYNC]

Mail Chimp Account [SYNC]

Request

Endpoint

GET /api/v2/account_lists/677f5755-43b1-4f04-835d-bbfe61a73a5d/mail_chimp_account/sync
Content-Type: application/vnd.api+json

Body

Response

Headers

Content-Type: text/html
200 OK

Body

Fields

Attributes

active

Type boolean

Description Active Account or Not

auto_log_campaigns

Type boolean

Description Auto Log Campaigns or Not

created_at

Type date

Description The timestamp of when this resource was created

lists_available_for_newsletters

Type ["Mail Chimp List"]

Description Lists available for newsletters

lists_link

Type string

Description Lists Link

lists_present

Type boolean

Description Lists Present or Not

primary_list_id

Type string

Description Primary List ID

primary_list_name

Type string

Description Primary List Name

updated_at

Type date

Description The timestamp of when this resource was last updated

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

valid

Type boolean

Description Valid

validate_key

Type boolean

Description Validate Key or Not

validation_error

Type string

Description Validation Error