Customer.io
v1.0.0
OpenAPI 3.1.0

Get a campaign action

US region

Client Libraries
Shell Curl

Get a campaign action

​

Returns information about a specific action in a campaign.

Path Parameters
  • campaign_id
    Type: integer
    required

    The ID of the campaign that you want to trigger or return information about.

  • action_id
    Type: integer
    required

    The action you want to lookup or act on.

Responses
  • application/json
  • 400

    The campaignID or actionID is invalid. It could also be that the language requested does not exist for this action.

  • 404

    The campaign and/or action do not exist.

  • 429

    Your request is over the 10-per-second limit.

Request Example for get/v1/campaigns/{campaign_id}/actions/{action_id}
curl https://api.customer.io/v1/campaigns/3/actions/1 \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "action": {
    "id": 96,
    "broadcast_id": 2,
    "deduplicate_id": "15:1492548073",
    "name": "Opening Message",
    "layout": "string",
    "created": 1552341937,
    "updated": 1552341937,
    "body": "string",
    "type": "email",
    "sending_state": "automatic",
    "language": "fr",
    "from": "sentFrom@example.com",
    "from_id": 1,
    "reply_to": "replyto@example.com",
    "reply_to_id": 38,
    "preprocessor": "premailer",
    "recipient": "{{customer.email}}",
    "subject": "Did you get that thing I sent you?",
    "cc": "string",
    "bcc": "string",
    "fake_bcc": true,
    "preheader_text": "string",
    "body_amp": "string",
    "campaign_id": 5,
    "parent_action_id": 1,
    "headers": "[{\"name\":\"X-Mailgun-Tag\",\"value\":\"my-cool-tag\"},{\"name\":\"X-Custom-Header\",\"value\":\"custom-value\"}]"
  }
}

Returns the requested campaign action.