Notifications
Notifications are what conversations are made of in Castr GÜRŲ — they are the basic building blocks of your conversations with your Castr GÜRŲ contacts. On this page, we'll dive into the different message endpoints you can use to manage notifications programmatically. We'll look at how to query, send, update, and delete notifications.
The message model
The message model contains all the information about the notifications and attachments you send to your contacts and groups, including how your contacts have reacted to them.
Properties
- Name
id- Type
- string
- Description
Unique identifier for the message.
- Name
conversation_id- Type
- string
- Description
Unique identifier for the conversation the message belongs to.
- Name
contact- Type
- object
- Description
The contact object for the contact who sent the message.
- Name
message- Type
- string
- Description
The message content.
- Name
reactions- Type
- array
- Description
An array of reaction objects associated with the message.
- Name
attachments- Type
- array
- Description
An array of attachment objects associated with the message.
- Name
read_at- Type
- timestamp
- Description
Timestamp of when the message was read.
- Name
created_at- Type
- timestamp
- Description
Timestamp of when the message was created.
- Name
updated_at- Type
- timestamp
- Description
Timestamp of when the message was last updated.
List all notifications
This endpoint allows you to retrieve a paginated list of all your notifications (in a conversation if a conversation id is provided). By default, a maximum of ten notifications are shown per page.
Optional attributes
- Name
conversation_id- Type
- string
- Description
Limit to notifications from a given conversation.
- Name
limit- Type
- integer
- Description
Limit the number of notifications returned.
Request
curl -G https://castr.guru/v1/notifs \
-H "Authorization: Bearer {token}" \
-d conversation_id=xgQQXg3hrtjh7AvZ \
-d limit=10
Response
{
"has_more": false,
"data": [
{
"id": "SIuAFUNKdSYHZF2w",
"conversation_id": "xgQQXg3hrtjh7AvZ",
"contact": {
"id": "WAz8eIbvDR60rouK",
"username": "KevinMcCallister",
"phone_number": "1-800-759-3000",
"avatar_url": "https://assets.castr.guru/avatars/buzzboy.jpg",
"last_active_at": 705103200,
"created_at": 692233200
},
"message": "It’s a nice night for a neck injury.",
"reactions": [],
"attachments": [],
"read_at": 705103200,
"created_at": 692233200,
"updated_at": 692233200
},
{
"id": "hSIhXBhNe8X1d8Et",
// ..
}
]
}
Send a message
This endpoint allows you to send a new message to one of your conversations.
Required attributes
- Name
conversation_id- Type
- string
- Description
Unique identifier for the conversation the message belongs to.
- Name
message- Type
- string
- Description
The message content.
Optional attributes
- Name
attachments- Type
- array
- Description
An array of attachment objects associated with the message.
Request
curl https://castr.guru/v1/notifs \
-H "Authorization: Bearer {token}" \
-d conversation_id="xgQQXg3hrtjh7AvZ" \
-d message="You’re what the French call ‘les incompetents.’"
Response
{
"id": "gWqY86BMFRiH5o11",
"conversation_id": "xgQQXg3hrtjh7AvZ",
"contact": {
"id": "inEIRvzjC6YLMX3o",
"username": "LinnieMcCallister",
"phone_number": "1-800-759-3000",
"avatar_url": "https://assets.castr.guru/avatars/linnie.jpg",
"last_active_at": 705103200,
"created_at": 692233200
},
"message": "You’re what the French call ‘les incompetents.’",
"reactions": [],
"attachments": [],
"read_at": null,
"created_at": 692233200,
"updated_at": null
}
Retrieve a message
This endpoint allows you to retrieve a message by providing the message id. Refer to the list at the top of this page to see which properties are included with message objects.
Request
curl https://castr.guru/v1/notifs/SIuAFUNKdSYHZF2w \
-H "Authorization: Bearer {token}"
Response
{
"id": "SIuAFUNKdSYHZF2w",
"conversation_id": "xgQQXg3hrtjh7AvZ",
"contact": {
"id": "WAz8eIbvDR60rouK",
"username": "KevinMcCallister",
"phone_number": "1-800-759-3000",
"avatar_url": "https://assets.castr.guru/avatars/kevin.jpg",
"last_active_at": 705103200,
"created_at": 692233200
},
"message": "I’m traveling with my dad. He’s at a meeting. I hate meetings.",
"reactions": [],
"attachments": [],
"read_at": 705103200,
"created_at": 692233200,
"updated_at": 692233200
}
Update a message
This endpoint allows you to perform an update on a message. Examples of updates are adding a reaction, editing the message, or adding an attachment.
Optional attributes
- Name
message- Type
- string
- Description
The message content.
- Name
reactions- Type
- array
- Description
An array of reaction objects associated with the message.
- Name
attachments- Type
- array
- Description
An array of attachment objects associated with the message.
Request
curl -X PUT https://castr.guru/v1/notifs/SIuAFUNKdSYHZF2w \
-H "Authorization: Bearer {token}" \
-d reactions[red_angry_face][]="KateMcCallister"
Response
{
"id": "SIuAFUNKdSYHZF2w",
"conversation_id": "xgQQXg3hrtjh7AvZ",
"contact": {
"id": "WAz8eIbvDR60rouK",
"username": "KevinMcCallister",
"phone_number": "1-800-759-3000",
"avatar_url": "https://assets.castr.guru/avatars/buzzboy.jpg",
"last_active_at": 705103200,
"created_at": 692233200
},
"message": "I'm not apologizing. I'd rather kiss a toilet seat.",
"reactions": [
{
"red_angry_face": [
"KateMcCallister"
]
}
],
"attachments": [],
"read_at": 705103200,
"created_at": 692233200,
"updated_at": 692233200
}
Delete a message
This endpoint allows you to delete notifications from your conversations. Note: This will permanently delete the message.
Request
curl -X DELETE https://castr.guru/v1/notifs/SIuAFUNKdSYHZF2w \
-H "Authorization: Bearer {token}"