Create Contact Renewal Reminder

POST 
https://secure.fleetio.com/api/v1/contact_renewal_reminders

Creates a new ContactRenewalReminder

Request

application/json

Body

contact_idintegerrequired

The ID of the Contact this Renewal Reminder is for.

contact_renewal_type_idintegerrequired

The ID of the Contact Renewal Type this Renewal Reminder is for.

activeboolean

Whether or not this Renewal Reminder is active.

next_due_atdaterequired

The date at which this Renewal Reminder is due. We recommend using ISO-8601 formatted dates to avoid ambiguity.

Example: 2023-03-14

due_soon_atdate

The date at which this Renewal Reminder is due soon. We recommend using ISO-8601 formatted dates to avoid ambiguity.

Example: 2023-03-14

due_soon_time_threshold_intervalinteger

Used in conjunction with due_soon_time_threshold_frequency. Together they form a full due soon parameter eg; "1 week", "5 months", "10 years"

due_soon_time_threshold_frequencyFrequency (string)nullable

Possible values: [day, week, month, year, days, weeks, months, years]

Responses

201

OK

Response Headers

application/json

Schema

Schema

idId (integer)required

Possible values: >= 1

created_atdate-time

The date and time at which this record was created.

Example: 2023-03-14T13:46:27-06:00

updated_atdate-time

The date and time at which this record was most recently updated.

Example: 2023-03-14T13:46:27-06:00

activebooleannullablerequired

Whether or not this Renewal Reminder is active.

next_due_atdate-timerequired

The date and time at which this Renewal Reminder is next due.

Example: 2023-03-14T13:46:27-06:00

last_sent_atdate-timenullablerequired

The date and time at which this Renewal Reminder was last sent.

Example: 2023-03-14T13:46:27-06:00

due_soon_atdate-timenullablerequired

The date and time at which this Renewal Reminder will next be marked as "Due Soon".

Example: 2023-03-14T13:46:27-06:00

due_soon_time_threshold_intervalintegernullablerequired

The amount of time before a Renewal is due where it will be marked as as "Due Soon".

due_soon_time_threshold_frequencyFrequency (string)nullablerequired

Possible values: [day, week, month, year, days, weeks, months, years]

account_idinteger

The ID of the Account that this Renewal Reminder belongs to.

contact_idId (integer)required

Possible values: >= 1

contact_renewal_type_idId (integer)required

Possible values: >= 1

contact_archived_atdate-timenullablerequired

The date and time at which this Renewal Reminder's Contact was archived.

Example: 2023-03-14T13:46:27-06:00

is_sampleboolean

Whether or not this belongs to sample data.

comments_countintegernullable

The number of Comments associated with this record.

watchers_countinteger

The number of watchers associated with this record.

Possible values: >= 0

watchable_optionsobject

Options related to watching the record.

bulk_watch_recordboolean

Indicates if a bulk watch record is created.

skip_automatic_watchers_callbacksboolean

Indicates if automatic watchers callbacks are skipped.

Example (auto)

{
  "id": 0,
  "created_at": "2023-03-14T13:46:27-06:00",
  "updated_at": "2023-03-14T13:46:27-06:00",
  "active": true,
  "next_due_at": "2023-03-14T13:46:27-06:00",
  "last_sent_at": "2023-03-14T13:46:27-06:00",
  "due_soon_at": "2023-03-14T13:46:27-06:00",
  "due_soon_time_threshold_interval": 0,
  "due_soon_time_threshold_frequency": "day",
  "account_id": 0,
  "contact_id": 0,
  "contact_renewal_type_id": 0,
  "contact_archived_at": "2023-03-14T13:46:27-06:00",
  "is_sample": true,
  "comments_count": 0,
  "watchers_count": 0,
  "watchable_options": {},
  "bulk_watch_record": true,
  "skip_automatic_watchers_callbacks": true
}

401

Request could not be authenticated

application/json

Schema

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (auto)

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

403

Insufficient permission to perform this operation

application/json

Schema

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (auto)

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

422

Unprocessable Entity

application/json

Schema

Schema

errors object
property name* string[]
Array [
string
]

Example (auto)

{
  "errors": {}
}

Example

{
  "errors": {
    "field1": [
      "error1",
      "error2"
    ],
    "field2": [
      "error3"
    ]
  }
}

500

Something unexpected happened

application/json

Schema

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (auto)

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: Prefix the value with "Token", for example: "Token 76cbe06c49a64".
You can generate a new API key [here](https://secure.fleetio.com/api_keys).

name: Account-Tokentype: apiKeyin: headerdescription: You can find your Account-Token [here](https://secure.fleetio.com/api_keys)

• curl
• ruby
• python
• csharp
• go
• java
• nodejs
• php

• CURL

curl -L 'https://secure.fleetio.com/api/v1/contact_renewal_reminders' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Token <Authorization>' \
-H 'Account-Token: <Authorization>' \
-d '{
  "contact_id": 0,
  "contact_renewal_type_id": 0,
  "active": true,
  "next_due_at": "2023-03-14",
  "due_soon_at": "2023-03-14",
  "due_soon_time_threshold_interval": 0,
  "due_soon_time_threshold_frequency": "day"
}'

Request Collapse all

Base URL

https://secure.fleetio.com/api

Auth

apiKey

accountToken

Body

{
  "contact_id": 0,
  "contact_renewal_type_id": 0,
  "active": true,
  "next_due_at": "2023-03-14",
  "due_soon_at": "2023-03-14",
  "due_soon_time_threshold_interval": 0,
  "due_soon_time_threshold_frequency": "day"
}

ResponseClear

Click the Send API Request button above and see the response here!