Posts
Known as 'Updates' in the API.
Get a Post by ID
GET
https://api.tiny.plus/v2/updates/{{id}}
This endpoint allows you to get a single news feed post.
Path Parameters
Name | Type | Description |
---|---|---|
id | number | ID of the contact |
Query Parameters
Name | Type | Description |
---|---|---|
with_related | boolean | Can be either |
Headers
Name | Type | Description |
---|---|---|
Authorization | string | Your access token. |
Example Usage
List Posts
GET
https://api.tiny.plus/v2/updates
This endpoint allows you to get a paginated list of News Feed Posts, optionally filtered by criteria.
Query Parameters
Name | Type | Description |
---|---|---|
{{field_name}} | string | You can provide any |
me | boolean | If this key is present, it will limit the results to only records where the user associated with the API key is the |
subscribed | string | Similar to the |
limit | number | Used for pagination. Limit is the number of records to return from the full resultset. The default is |
start | number | Used for pagination. Set this value to the cursor position into the total resultset to return this time. eg. to receive the 101st to the 115th record, set this to |
sort | string | Provide a field name and optionally a direction separated by a space to sort the returned results. For example, |
return_format | string | Can be either |
Headers
Name | Type | Description |
---|---|---|
Authorization | string | Your access token. |
Example Usage
Create a Post
POST
https://api.tiny.plus/v2/updates
You can create a new news feed post with this endpoint.
Query Parameters
Name | Type | Description |
---|---|---|
return_record | boolean | Add this parameter to get a copy of the newly created record. Save yourself a call! |
Headers
Name | Type | Description |
---|---|---|
Accepts | string | Use |
Content-Type | string | Use |
Authorization | string | Your access token. |
Request Body
Name | Type | Description |
---|---|---|
description | string | The content of the new post you want to make. Do not include HTML. |
related_id | integer | A single record id of a project, company, contact or other tiny+ record which this post relates to. |
extra_ids | string | Pass optional extra ids, separated by a comma (,) of any supported record type(s) to also relate the post to these records. You may pass up to 5 record ids in this way.
eg: |
created_user | integer | The user id who should be attributed to this post. The default is the user related to the access token. |
Delete a Post
DELETE
https://api.tiny.plus/v2/updates/{{id}}
Delete a News Feed Post.
Path Parameters
Name | Type | Description |
---|---|---|
id | string | ID of the post. |
Headers
Name | Type | Description |
---|---|---|
Authorization | string | Your access token. |
Posts Field Reference
Field | Type | Details | Permission |
id | Number | Unique record identifier. | Read-only |
name | Auto-generated String | This is an auto-generated shortening of the start of the description field, with all non-printable characters removed. | Full |
description | String REQUIRED | The body of the post. | Full |
description_HTML | String | The description field but with certain HTML elements intact, such as embedded videos. | Read-only |
created_date | String (YYYY-MM-DD hh:mm:ss) | Date record was first created. | Read-only |
modified_date | String (YYYY-MM-DD hh:mm:ss) | Date record was last modified. | Read-only |
created_user | Number | ID of user who made the record. | Read-only |
modified_user | Number | ID of user who last edited the record. | Read-only |
assigned_user | Number | ID of assigned user. | Full |
record_url | String | The fully qualified URI of the record. | Read-only |
created_user_record | Object | An object containing details about the created_user. | Read-only |
attached | Object | An array of objects containing all the related records attached to this post. | Read-only |
images | Object | An array of objects containing details of any images associated with this post. | Read-only |
social | Object | Refer below. | Read-only |
broadcast | Boolean | Whether to show this post in the main tiny+ news feed. Either | Full |
Last updated