Create conversation
Last updated
Was this helpful?
Last updated
Was this helpful?
curl -X POST "https://api.bird.com/workspaces/a1405560-c8d3-4b1a-877d-3f449ad95352/conversations" \
-H "Content-Type: application/json" \
-H "Authorization: AccessKey abcd" \
-d '{
"name": "Email Subject",
"channelId": "25431165-c486-4a94-94f6-b3633c9af905",
"participants": [
{
"type": "contact",
"identifierKey": "emailaddress",
"identifierValue": "john.doe@bird.com"
}
],
"initialMessage": {
"body": {
"type": "text",
"text": {
"text": "Hey, listen!"
}
},
"recipients": [
{
"identifierKey": "emailaddress",
"identifierValue": "john.doe@bird.com",
"type": "to"
}
]
},
"attributes": {
"my-custom-attribute": "123"
}
}'{
"id": "2280c45c-60d5-45a2-b51d-06ea752ca167",
"name": "Email Subject",
"description": "",
"status": "active",
"visibility": "public",
"accessibility": "open",
"featuredParticipants": [
{
"id": "192c4449-9ccd-4747-8969-3bf07696af1c",
"type": "accessKey",
"status": "active",
"displayName": "My first email key",
"avatarUrl": ""
},
{
"id": "2d789fa4-85b7-4e59-b862-48062a0c0aa8",
"type": "contact",
"status": "active",
"displayName": "John Doe",
"avatarUrl": "",
"contact": {
"identifierKey": "emailaddress",
"identifierValue": "john.doe@bird.com",
"platformAddress": "john.doe@bird.com"
}
}
],
"activeParticipantCount": 2,
"pendingParticipantCount": 0,
"initiatingParticipant": {
"id": "192c4449-9ccd-4747-8969-3bf07696af1c",
"type": "accessKey",
"status": "active",
"displayName": "My first email key",
"avatarUrl": ""
},
"channelId": "25431165-c486-4a94-94f6-b3633c9af905",
"lastMessage": {
"id": "1c3a1c2d-2d27-4d5d-b7e4-ce62aecbba06",
"type": "text",
"preview": {
"text": "Hey, listen!"
},
"recipients": [
{
"type": "to",
"id": "2d789fa4-85b7-4e59-b862-48062a0c0aa8",
"identifierKey": "emailaddress",
"identifierValue": "john.doe@bird.com",
"platformAddress": "john.doe@bird.com",
"contactAnnotation": {
"name": "John Doe"
}
}
],
"status": "accepted",
"sender": {
"id": "192c4449-9ccd-4747-8969-3bf07696af1c",
"type": "accessKey",
"status": "active",
"displayName": "My first email key",
"avatarUrl": ""
},
"createdAt": "2024-11-29T13:47:08.59Z"
},
"createdAt": "2024-11-29T13:47:08.546Z",
"updatedAt": "2024-11-29T13:47:08.591Z",
"platformStyle": "email",
"attributes": {
"my-custom-attribute": "123"
}
}curl -X POST "https://api.bird.com/workspaces/a1405560-c8d3-4b1a-877d-3f449ad95352/conversations" \
-H "Content-Type: application/json" \
-H "Authorization: AccessKey abcd" \
-d '{
"name": "Email Subject",
"channelId": "25431165-c486-4a94-94f6-b3633c9af905",
"participants": [
{
"type": "contact",
"identifierKey": "emailaddress",
"identifierValue": "john.doe@bird.com"
}
],
"initialMessage": {
"template": {
"projectId": "5d9084b3-7cdb-4c87-bf7c-8871a1f21695",
"version": "b33761d9-ece1-48e3-b542-b5bbf93bd8c3",
"locale": "en",
"parameters": [
{
"type": "string",
"key": "myVariable",
"value": "yay"
}
]
},
"recipients": [
{
"identifierKey": "emailaddress",
"identifierValue": "john.doe@bird.com",
"type": "to"
}
]
},
"attributes": {
"my-custom-attribute": "123"
}
}'{
"id": "efec8397-c992-4195-9b1e-319b6ba8be26",
"name": "Email Subject",
"description": "",
"status": "active",
"visibility": "public",
"accessibility": "open",
"featuredParticipants": [
{
"id": "68b80b8d-8060-42df-bda3-73505a8fdb84",
"type": "accessKey",
"status": "active",
"displayName": "My first email key",
"avatarUrl": ""
},
{
"id": "8f0b5377-2edc-4116-a8e8-6a475f245a04",
"type": "contact",
"status": "active",
"displayName": "John Doe",
"avatarUrl": "",
"contact": {
"identifierKey": "emailaddress",
"identifierValue": "john.doe@bird.com",
"platformAddress": "john.doe@bird.com"
}
}
],
"activeParticipantCount": 2,
"pendingParticipantCount": 0,
"initiatingParticipant": {
"id": "68b80b8d-8060-42df-bda3-73505a8fdb84",
"type": "accessKey",
"status": "active",
"displayName": "My first email key",
"avatarUrl": ""
},
"channelId": "cb4b1ebc-34e6-5a7a-a375-f6f2f131d88f",
"lastMessage": {
"id": "8849a1da-f8e9-41fa-8e60-8e12b1c6ed1a",
"type": "html",
"preview": {
"text": ""
},
"recipients": [
{
"type": "to",
"id": "8f0b5377-2edc-4116-a8e8-6a475f245a04",
"identifierKey": "emailaddress",
"identifierValue": "john.doe@bird.com",
"platformAddress": "john.doe@bird.com",
"contactAnnotation": {
"name": "John Doe"
}
}
],
"status": "accepted",
"sender": {
"id": "68b80b8d-8060-42df-bda3-73505a8fdb84",
"type": "accessKey",
"status": "active",
"displayName": "My first email key",
"avatarUrl": ""
},
"createdAt": "2024-12-02T13:42:06.876Z"
},
"createdAt": "2024-12-02T13:42:06.686Z",
"updatedAt": "2024-12-02T13:42:06.877Z",
"platformStyle": "email",
"attributes": {
"my-custom-attribute": "123"
}
}curl -X POST "https://api.bird.com/workspaces/a1405560-c8d3-4b1a-877d-3f449ad95352/conversations" \
-H "Content-Type: application/json" \
-H "Authorization: AccessKey abcd" \
-d '{
"name": "Ticket name",
"channelId": "199f0353-fcb8-41b2-afd6-614c6baf3850",
"participants": [
{
"type": "contact",
"identifierKey": "phonenumber",
"identifierValue": "+31612345678"
}
],
"initialMessage": {
"template": {
"projectId": "4720942c-9bde-4934-ab77-f600743894a1",
"version": "5c0e4db5-20f2-4224-86f4-fce052997608",
"locale": "en",
"parameters": [
{
"type": "string",
"key": "age",
"value": "20"
}
]
},
"recipients": [
{
"identifierKey": "phonenumber",
"identifierValue": "+31612345678",
"type": "to"
}
]
},
"attributes": {
"my-custom-attribute": "123"
}
}'{
"id": "50a23da3-2ad9-42dd-94af-65b1b4271cb9",
"name": "Ticket name",
"description": "",
"status": "active",
"visibility": "public",
"accessibility": "open",
"featuredParticipants": [
{
"id": "f9129db4-b39e-4dab-aa2f-e55904e90104",
"type": "accessKey",
"status": "active",
"displayName": "My first key",
"avatarUrl": ""
},
{
"id": "f64db2ae-d6cb-4a3d-b1e1-2401fdf02f27",
"type": "contact",
"status": "active",
"displayName": "John Doe",
"avatarUrl": "",
"contact": {
"identifierKey": "phonenumber",
"identifierValue": "+31612345678",
"platformAddress": "+31612345678"
}
}
],
"activeParticipantCount": 2,
"pendingParticipantCount": 0,
"initiatingParticipant": {
"id": "f9129db4-b39e-4dab-aa2f-e55904e90104",
"type": "accessKey",
"status": "active",
"displayName": "My first key",
"avatarUrl": ""
},
"channelId": "199f0353-fcb8-41b2-afd6-614c6baf3850",
"lastMessage": {
"id": "25b3b6a2-7e1f-49ec-9371-b9a945fd6cec",
"type": "list",
"preview": {
"text": "Message type 'list' was sent."
},
"recipients": [
{
"type": "to",
"id": "f64db2ae-d6cb-4a3d-b1e1-2401fdf02f27",
"identifierKey": "phonenumber",
"identifierValue": "+31612345678",
"platformAddress": "+31612345678",
"contactAnnotation": {
"name": "John Doe"
}
}
],
"status": "accepted",
"sender": {
"id": "f9129db4-b39e-4dab-aa2f-e55904e90104",
"type": "accessKey",
"status": "active",
"displayName": "My first key",
"avatarUrl": ""
},
"createdAt": "2024-12-02T14:52:42.583Z"
},
"createdAt": "2024-12-02T14:52:42.484Z",
"updatedAt": "2024-12-02T14:52:42.583Z",
"platformStyle": "direct",
"attributes": {
"my-custom-attribute": "123"
}
}Create a new conversation for a workspace, optionally specifying an initial message to be sent.
The workspace ID
b4e02c85-c6d2-4b15-8885-e09671799c61POST /workspaces/{workspaceId}/conversations HTTP/1.1
Host: api.bird.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 1070
{
"name": "Re: Your refund request",
"description": "Refund request ticket",
"style": "default",
"visibility": "public",
"accessibility": "open",
"participants": [
{
"id": "986c5b08-3ec7-424a-a380-f3b41dc02746",
"type": "user"
}
],
"channelId": null,
"initialMessage": {
"reference": "my-own-business-logic-id-12345",
"sender": {
"name": "Bird Support",
"email": "example@bird.com"
},
"recipients": [
{
"identifierKey": "emailaddress",
"identifierValue": "example@bird.com",
"platformAddressSelector": "attributes.workEmail",
"type": "to"
}
],
"body": {
"type": "text",
"text": {
"text": "text",
"attachments": [
{
"mediaUrl": "https://example.com",
"filename": "text",
"inline": true
}
],
"actions": [
{
"type": "link",
"link": {
"text": "text",
"url": "text"
}
}
],
"metadata": {
"subject": "text",
"headers": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"whatsapp": {
"previewUrl": true
},
"line": {
"emoji": {
"items": [
{
"index": 1,
"productId": "text",
"emojiId": "text"
}
]
}
},
"telegram": {
"parseMode": "Markdown"
}
}
}
},
"draft": false
},
"attributes": {
"myCustomField": "abc"
},
"resource": {
"type": "task",
"id": "123e4567-e89b-12d3-a456-426614174000"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"id": "299227f5-1c61-4341-ad50-efed5c048998",
"name": "Re: Your refund request",
"description": "Refund request ticket",
"status": "active",
"visibility": "public",
"accessibility": "open",
"style": "default",
"featuredParticipants": [
{
"id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
"displayName": "John Doe",
"avatarUrl": "https://example.bird.com/avatar-url",
"contact": {
"identifierKey": "emailaddress",
"identifierValue": "example@bird.com",
"platformAddress": "example@bird.com",
"platformAddressSelector": "attributes.workEmail"
},
"type": "user",
"status": "active"
}
],
"initiatingParticipant": {
"id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
"displayName": "John Doe",
"avatarUrl": "https://example.bird.com/avatar-url",
"contact": {
"identifierKey": "emailaddress",
"identifierValue": "example@bird.com",
"platformAddress": "example@bird.com",
"platformAddressSelector": "attributes.workEmail"
},
"type": "user",
"status": "active"
},
"activeParticipantCount": 2,
"pendingParticipantCount": 1,
"channelId": "ab651378-579a-4491-abe6-eec97d4c0fa3",
"lastMessage": {
"id": "69e97125-ddd4-4042-9d58-8350e806e1de",
"type": "text",
"preview": {
"text": "Thank you for reaching out, could you please inform your account number?"
},
"status": "accepted",
"sender": {
"id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
"displayName": "John Doe",
"avatarUrl": "https://example.bird.com/avatar-url",
"contact": {
"identifierKey": "emailaddress",
"identifierValue": "example@bird.com",
"platformAddress": "example@bird.com",
"platformAddressSelector": "attributes.workEmail"
},
"type": "user",
"status": "active"
},
"recipients": [
{
"id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
"type": "to",
"identifierKey": "emailaddress",
"identifierValue": "example@bird.com",
"platformAddress": "text",
"platformAddressSelector": "attributes.workEmail",
"contactAnnotation": {
"name": "John Doe"
}
}
],
"draft": true,
"createdAt": "2024-01-01T00:00:00.123Z"
},
"lastMessageIncomingAt": "2025-06-02T08:41:42.157Z",
"lastMessageOutgoingAt": "2025-06-02T08:41:42.157Z",
"createdAt": "2024-01-01T00:00:00.123Z",
"updatedAt": "2024-01-01T00:00:00.123Z",
"platformStyle": "direct",
"attributes": {
"myCustomField": "abc"
},
"summary": "Re: Your refund request",
"referral": {
"sourceUrl": "https://instagram.com/p/EXAMPLEID",
"sourceId": "120211000000000000",
"sourceType": "AD",
"mediaUrl": "https://cdninstagram.com/v/example",
"mediaType": "IMAGE",
"caption": "Introducing Dream Summer Days Daily SPF, your go-to sunscreen for safeguarding your skin's glow under the sun's embrace.",
"title": "Dream Summer Days Daily SPF",
"text": "Crafted with broad-spectrum SPF 50+ protection, Dream Summer Days Daily SPF offers reliable defense against both UVA and UVB rays",
"username": "DreamCosmetics",
"timestamp": "2024-11-28T12:00:00.000Z"
},
"likelySpam": true,
"likelySpamReason": "advertisement",
"resource": {
"type": "task",
"id": "123e4567-e89b-12d3-a456-426614174000"
}
}