MailcrateDocs
External audiences

Create an external audience source

POST
/public/external-audience-source

Requires the external-audience:write scope.

Authorization

ApiKey
headerAuthorization<token>

Api-Key mc_... — a workspace API key.

Request Body

application/json
  1. body
name*string
sourceType?string
listingUrl?string
Formaturi
authType?string
Value in"api-key""basic""bearer""none"
authConfig?
description?string

Response Body

application/json
  1. response
id*string
workspaceId*string
name*string
description*string|null
sourceType*string
listingUrl*string
authType*string
Value in"api-key""basic""bearer""none"
authConfig*|null
lastSyncedAt*|
Formatdate-time
lastSyncError*string|null
created*string
Formatdate-time
updated*string
Formatdate-time
Example Request
curl -X POST 'https://api.mailcrate.io/public/external-audience-source' \  -H 'Authorization: Api-Key <api_key>' \  -H 'Content-Type: application/json' \  -d '{  "name": "string"}'
Example Response
{  "id": "string",  "workspaceId": "string",  "name": "string",  "description": "string",  "sourceType": "string",  "listingUrl": "string",  "authType": "api-key",  "authConfig": {},  "lastSyncedAt": "2019-08-24T14:15:22Z",  "lastSyncError": "string",  "created": "2019-08-24T14:15:22Z",  "updated": "2019-08-24T14:15:22Z"}

Record a contact event POST

Records a custom event against a contact, which segments and journey triggers can match on. Identify the contact by `contactId`, `email` or `externalIdentifier`. Requires the `event:write` scope.

Create an external audience POST

Requires the `external-audience:write` scope.