Sendouts
Create Sendout
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Query Parameters
include?array<>
Additional fields to include in the response. Use repeated query syntax: include=foo&include=bar
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
id?string
Format
uuidmode*"broadcast"
from*string
Format
uuidtemplate_id*string
Format
uuidrequire_marketing_opt_in?boolean
Default
trueto_recipients?array<>
Default
[]to_segments?array<>
Default
[]send_after?string
Format
date-timeplaceholder_values?array<string>
review_channel_id?string
Format
uuidheader_media?
Response Body
application/json
curl -X POST "https://api.getmateo.com/v1/sendouts" \ -H "Content-Type: application/json" \ -d '{ "mode": "broadcast", "from": "dee192b0-275e-44a2-9c77-32b75da2f26f", "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc" }'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "organisation_id": "9ec26450-a51e-40b1-a49f-e04045480fd5", "campaign_id": "78614b6c-fe7c-41e2-8e25-c9b3a3c91904", "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc", "mode": "broadcast", "require_marketing_opt_in": true, "send_after": "2019-08-24T14:15:22Z", "placeholder_values": [ "string" ], "contacts": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "external_id": "string", "secondary_external_id": "string", "full_name": "string", "email": "string", "sms": "string", "whatsapp": "string", "instagram": "string", "facebook": "string", "google_business_messaging": "string", "postal": "string", "placeholder_values": [ "string" ] } ], "filter": {}, "marketing_channel_id": "ae5680ad-b032-4fd0-b011-98eba965b308", "review_channel_id": "ee220a3f-5683-4244-a09c-c291f465ddc9", "completed": true, "use_omni_channel_message": true, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "header_media": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "filename": "string", "purpose": "media_library", "path": "string", "size": -9007199254740991, "type": "string", "metadata": { "property1": null, "property2": null }, "user_metadata": { "property1": null, "property2": null } }}