Simulation API. (0.0.1)

Download OpenAPI specification:Download

APIs for sending Campaign Proofs.

Campaign Proof API

Trigger Campaign Proof Job

Use this API to trigger proof job of a Campaign. Sending Campaign proof is an async process, the API will return a proofJobId which can be used to check the status of the proof.

SecurityimsUserToken

Request

path Parameters

campaignId

required

string

Campaign Id

Example: 8fd4b5e2-e559-425b-bd89-389b007d32d5

header Parameters

Authorization required	string Authorization token Example: Bearer {{token}}
x-api-key required	string API Key located in Adobe Developer Console Example: 829495afa589475ab56850a702359cf9
x-gw-ims-org-id required	string Your Identity Management Services (IMS) Organization id Example: 0A7F574EBB4C6E1423973F52@AdobeOrg
x-sandbox-name required	string Filter on platform sandbox name Example: prod

Request Body schema: application/json

Campaign Proof Request

Array of objects (Recipient) non-empty

Recipients

Responses

200

Success Response

400

Bad Request

401

Not Authorized

403

Forbidden

404

Not Found

post/campaigns/{campaignId}/proofs

Request samples

Payload

application/json

{"recipients": [{"userId": "test@gmail.com",
"namespace": "Email",
"channelsData": [{"channel": "email",
"subjectPrefix": "string",
"emailAddresses": ["test@gmail.com"
]
}
],
"profile": { },
"context": { }
}
]
}

Response samples

application/json

{"proofJobId": "d516349b-9b10-492a-92bb-ea9d941c2df2",
"status": "CREATED",
"proofs": [{"messageId": "8fd4b5e2-e559-425b-bd89-389b007d32d5",
"variantId": "2d277062-b2d8-441c-85e6-6eb99b6a8600",
"startDate": "string",
"targeted": 0,
"submitted": 0,
"status": "CREATED",
"proofFailureReasons": [{"profileIds": ["test@gmail.com"
],
"failureReasons": [{"type": "https://ns.adobe.com/aep/errors/CJMPTS-1000-400",
"title": "A concise error message",
"status": 400,
"report": {"tenantInfo": null,
"additionalContext": { }
},
"error-chain": [{ }
]
}
]
}
]
}
],
"_links": {"self": {"href": "/campaign/8fd4b5e2-e559-425b-bd89-389b007d32d5/proof/8fd4b5e2-e559-425b-bd89-389b007d32d5"
}
}
}

Get Campaign Proof Status

Use this API to get status of a Campaign Proof

SecurityimsUserToken

Request

path Parameters

campaignId required	string Campaign Id Example: 8fd4b5e2-e559-425b-bd89-389b007d32d5
proofJobId required	string Campaign proof job Id Example: 2b380e1d-e4e2-4451-a5f7-3968af23e8c2

header Parameters

Authorization required	string Authorization token Example: Bearer {{token}}
x-api-key required	string API Key located in Adobe Developer Console Example: 829495afa589475ab56850a702359cf9
x-gw-ims-org-id required	string Your Identity Management Services (IMS) Organization id Example: 0A7F574EBB4C6E1423973F52@AdobeOrg
x-sandbox-name required	string Filter on platform sandbox name Example: prod

Responses

200

Success Response

400

Bad Request

401

Not Authorized

403

Forbidden

404

Not Found

get/campaign/{campaignId}/proofs/{proofJobId}

Response samples

application/json

{"proofJobId": "d516349b-9b10-492a-92bb-ea9d941c2df2",
"status": "CREATED",
"proofs": [{"messageId": "8fd4b5e2-e559-425b-bd89-389b007d32d5",
"variantId": "2d277062-b2d8-441c-85e6-6eb99b6a8600",
"startDate": "string",
"targeted": 0,
"submitted": 0,
"status": "CREATED",
"proofFailureReasons": [{"profileIds": ["test@gmail.com"
],
"failureReasons": [{"type": "https://ns.adobe.com/aep/errors/CJMPTS-1000-400",
"title": "A concise error message",
"status": 400,
"report": {"tenantInfo": null,
"additionalContext": { }
},
"error-chain": [{ }
]
}
]
}
]
}
],
"_links": {"self": {"href": "/campaign/8fd4b5e2-e559-425b-bd89-389b007d32d5/proof/8fd4b5e2-e559-425b-bd89-389b007d32d5"
}
}
}