Offer
Add a recipient to an offer
POST
/
offers
/
{id}
/
recipients
Authorizations
Authorization
string
headerrequiredValue for the Authorization header parameter.
Path Parameters
id
string
requiredOffer identifier
Body
firstName
string
The first name of the recipient
lastName
string
The last name of the recipient
email
string
The email of the recipient. This will be used to send the email.
role
enum<string>
The role of the recipient
Possible values:
read: The recipient can read the offersign: The recipient can read and sign the offer
Available options:
read, sign Response
201 - application/json
id
string
subscription
object
customer
object
number
string
name
string | null
status
enum<string>
Available options:
open, signed, signing, archived description
string | null
sections
string[]
locale
string
recipients
object[]
auditLogDocument
object
signedDocument
object
signedAt
string | null
autoActivateSubscription
boolean
default: truecrmDealId
string | null
createdAt
string
The date and time when the resource was created.
updatedAt
string
The date and time when the resource was last updated.
contactPerson
object
The contact person of the offer
Was this page helpful?