Onfleet Recipients API
Create and look up end customers (recipients) by ID, name, or E.164 phone number. Recipients carry SMS notification preferences and metadata, and can be reused across tasks.
OpenAPI Specification
openapi: 3.0.3
info:
title: Onfleet Destinations Recipients API
description: 'The Destinations API manages physical addresses associated with tasks.
Destinations include parsed address fields and a GeoJSON location, and can
be reused across tasks. Onfleet geocodes addresses on creation; you can
also supply an `unparsed` address.
'
version: '2.7'
contact:
name: Onfleet Support
email: support@onfleet.com
license:
name: Onfleet Terms of Service
url: https://onfleet.com/legal
servers:
- url: https://onfleet.com/api/v2
description: Production
security:
- basicAuth: []
tags:
- name: Recipients
paths:
/recipients:
post:
tags:
- Recipients
summary: Create Recipient
operationId: createRecipient
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RecipientCreate'
responses:
'200':
description: Recipient created
content:
application/json:
schema:
$ref: '#/components/schemas/Recipient'
/recipients/{recipientId}:
parameters:
- name: recipientId
in: path
required: true
schema:
type: string
get:
tags:
- Recipients
summary: Get Recipient By ID
operationId: getRecipient
responses:
'200':
description: Recipient
content:
application/json:
schema:
$ref: '#/components/schemas/Recipient'
put:
tags:
- Recipients
summary: Update Recipient
operationId: updateRecipient
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RecipientCreate'
responses:
'200':
description: Updated recipient
content:
application/json:
schema:
$ref: '#/components/schemas/Recipient'
/recipients/name/{name}:
get:
tags:
- Recipients
summary: Get Recipient By Name
operationId: getRecipientByName
parameters:
- name: name
in: path
required: true
schema:
type: string
responses:
'200':
description: Recipient
content:
application/json:
schema:
$ref: '#/components/schemas/Recipient'
/recipients/phone/{phone}:
get:
tags:
- Recipients
summary: Get Recipient By Phone
operationId: getRecipientByPhone
parameters:
- name: phone
in: path
required: true
schema:
type: string
description: E.164 formatted phone number.
responses:
'200':
description: Recipient
content:
application/json:
schema:
$ref: '#/components/schemas/Recipient'
components:
schemas:
Recipient:
type: object
properties:
id:
type: string
organization:
type: string
timeCreated:
type: integer
format: int64
timeLastModified:
type: integer
format: int64
name:
type: string
phone:
type: string
notes:
type: string
skipSMSNotifications:
type: boolean
metadata:
type: array
items:
type: object
RecipientCreate:
type: object
required:
- name
- phone
properties:
name:
type: string
phone:
type: string
notes:
type: string
skipSMSNotifications:
type: boolean
useRecipientLanguage:
type: boolean
metadata:
type: array
items:
type: object
required:
- name
- type
- value
properties:
name:
type: string
type:
type: string
value: {}
securitySchemes:
basicAuth:
type: http
scheme: basic