Create an expiration item
POST
https://api.expirationreminder.net/v1/expirationitemsRequest Body
| Property | Type | Required | Description |
|---|---|---|---|
id |
string (uuid) |
No | - |
name |
string |
Yes | - |
expiration_date |
string |
Yes | - |
status |
string |
No | - |
time_of_day |
string |
No | - |
category |
object |
No | - |
details |
string |
No | - |
assigned_to |
object |
No | - |
status_id |
integer (int32) |
No | - |
modified |
string |
No | - |
category_name |
string |
No | - |
is_active |
boolean |
No | - |
team_id |
string (uuid) |
No | - |
contacts |
object[] |
No | - |
attachments |
object[] |
No | - |
custom_fields |
object[] |
No | - |
locations |
object[] |
No | - |
tags |
object[] |
No | - |
contact_id |
string (uuid) |
No | - |
Sample Request
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"expiration_date": "string",
"status": "string",
"time_of_day": "string",
"category": {
"name": "string",
"id": "00000000-0000-0000-0000-000000000000",
"modified": "string",
"is_active": false,
"team_id": "00000000-0000-0000-0000-000000000000",
"custom_fields": [
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"internal_name": "string"
}
]
},
"details": "string",
"assigned_to": {
"name": "string",
"email": "string",
"id": "00000000-0000-0000-0000-000000000000",
"team_id": "00000000-0000-0000-0000-000000000000"
},
"status_id": 0,
"modified": "string",
"category_name": "string",
"is_active": false,
"team_id": "00000000-0000-0000-0000-000000000000",
"contacts": [
{
"name": "string",
"id": "00000000-0000-0000-0000-000000000000",
"email": "string",
"timezone": "string",
"mobile": "string",
"phone": "string",
"assigned_to": {
"name": "string",
"email": "string",
"id": "00000000-0000-0000-0000-000000000000",
"team_id": "00000000-0000-0000-0000-000000000000"
},
"type_id": "00000000-0000-0000-0000-000000000000",
"contact_id": "string",
"location_id": "00000000-0000-0000-0000-000000000000",
"team_id": "00000000-0000-0000-0000-000000000000",
"is_active": false,
"modified": "string",
"custom_fields": [
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"value": "string"
}
]
}
],
"attachments": [
{
"id": "00000000-0000-0000-0000-000000000000",
"content": "string",
"name": "string",
"content_type": "string",
"created": "string",
"content_legth": 0
}
],
"custom_fields": [
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"value": "string"
}
],
"locations": [
{
"id": "00000000-0000-0000-0000-000000000000",
"parent_location_id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"team_id": "00000000-0000-0000-0000-000000000000",
"modified": "string",
"custom_fields": [
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"value": "string"
}
]
}
],
"tags": [
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"team_id": "00000000-0000-0000-0000-000000000000",
"modified": "string",
"organization_id": "00000000-0000-0000-0000-000000000000"
}
],
"contact_id": "00000000-0000-0000-0000-000000000000"
}POST /v1/expirationitems
$ curl https://api.expirationreminder.net/v1/expirationitems \
-H "Authorization: Bearer <token>"
Responses
| Property | Type | Description |
|---|---|---|
id |
string (uuid) |
- |
name |
string |
- |
expiration_date |
string |
- |
status |
string |
- |
time_of_day |
string |
- |
category |
object |
- |
details |
string |
- |
assigned_to |
object |
- |
status_id |
integer (int32) |
- |
modified |
string |
- |
category_name |
string |
- |
is_active |
boolean |
- |
team_id |
string (uuid) |
- |
contacts |
object[] |
- |
attachments |
object[] |
- |
custom_fields |
object[] |
- |
locations |
object[] |
- |
tags |
object[] |
- |
contact_id |
string (uuid) |
- |
Example Response
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"expiration_date": "string",
"status": "string",
"time_of_day": "string",
"category": {
"name": "string",
"id": "00000000-0000-0000-0000-000000000000",
"modified": "string",
"is_active": false,
"team_id": "00000000-0000-0000-0000-000000000000",
"custom_fields": [
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"internal_name": "string"
}
]
},
"details": "string",
"assigned_to": {
"name": "string",
"email": "string",
"id": "00000000-0000-0000-0000-000000000000",
"team_id": "00000000-0000-0000-0000-000000000000"
},
"status_id": 0,
"modified": "string",
"category_name": "string",
"is_active": false,
"team_id": "00000000-0000-0000-0000-000000000000",
"contacts": [
{
"name": "string",
"id": "00000000-0000-0000-0000-000000000000",
"email": "string",
"timezone": "string",
"mobile": "string",
"phone": "string",
"assigned_to": {
"name": "string",
"email": "string",
"id": "00000000-0000-0000-0000-000000000000",
"team_id": "00000000-0000-0000-0000-000000000000"
},
"type_id": "00000000-0000-0000-0000-000000000000",
"contact_id": "string",
"location_id": "00000000-0000-0000-0000-000000000000",
"team_id": "00000000-0000-0000-0000-000000000000",
"is_active": false,
"modified": "string",
"custom_fields": [
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"value": "string"
}
]
}
],
"attachments": [
{
"id": "00000000-0000-0000-0000-000000000000",
"content": "string",
"name": "string",
"content_type": "string",
"created": "string",
"content_legth": 0
}
],
"custom_fields": [
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"value": "string"
}
],
"locations": [
{
"id": "00000000-0000-0000-0000-000000000000",
"parent_location_id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"team_id": "00000000-0000-0000-0000-000000000000",
"modified": "string",
"custom_fields": [
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"value": "string"
}
]
}
],
"tags": [
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"team_id": "00000000-0000-0000-0000-000000000000",
"modified": "string",
"organization_id": "00000000-0000-0000-0000-000000000000"
}
],
"contact_id": "00000000-0000-0000-0000-000000000000"
}Bad Request
| Property | Type | Description |
|---|---|---|
message |
string |
- |
ok |
boolean |
- |
Example Response
{
"message": "string",
"ok": false
}Conflict
| Property | Type | Description |
|---|---|---|
message |
string |
- |
ok |
boolean |
- |
Example Response
{
"message": "string",
"ok": false
}