Skip to main content
POST
/
offers
/
{id}
/
recipients
cURL
curl -X POST \
 /offers/{id}/recipients \
 --header "Content-Type: application/json" \
 --header "Authorization: Bearer <token>" \
 --data '{
    "firstName": "",
    "lastName": "",
    "email": "",
    "sendEmail": ""
}'
{
  "id": "<string>",
  "subscription": {
    "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
    "externalId": "<string>",
    "paymentMethod": {
      "id": "<string>",
      "gatewayName": "wallet",
      "type": "sepa_debit",
      "default": true,
      "status": "active",
      "enabled": true,
      "name": "<string>",
      "creationDate": "2023-11-07T05:31:56Z",
      "expirationDate": "2023-11-07T05:31:56Z",
      "card": {
        "brand": "Visa",
        "last4": "4242",
        "expMonth": 12,
        "expYear": 2022,
        "cardHolder": "Max Mustermann"
      },
      "sepaDebit": {
        "iban": "DE8937*********3232",
        "bic": "COBADEFFXXX",
        "mandateReference": "MNDT-2021-123456",
        "signingDate": "2021-01-01T00:00:00+00:00"
      },
      "paypal": {
        "email": "[email protected]",
        "billingAgreementId": "I-1J5gqz2eZvKYlo2C2X2X2X2X"
      }
    },
    "invoiceAddress": {},
    "number": "S-00000001",
    "customer": {
      "id": "00000000-0000-0000-0000-000000000000",
      "customerNumber": "CUSTOMER-000",
      "timeZone": "Europe/Berlin",
      "firstName": "John",
      "lastName": "Doe",
      "currencyCode": "EUR",
      "companyName": "Acme Inc.",
      "datevId": "123456789",
      "status": "STATUS_ACTIVE"
    },
    "plan": {
      "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
      "family": {
        "createdAt": "2021-01-01T00:00:00+00:00",
        "updatedAt": "2021-01-01T00:00:00+00:00"
      },
      "code": "basic-m2023",
      "allowCheckout": true,
      "status": "draft",
      "changeBehaviour": "upgradeable_and_downgradeable",
      "changeApplyBehaviour": "end_of_period"
    },
    "name": "Fitness M",
    "items": [
      {
        "id": "01F9ZQZJZJQZJZJZJZJZJZJZJZ",
        "name": "Fitness M",
        "description": "Everything included",
        "furtherInformation": "Additional agreements: The contract includes a free drink flatrate.",
        "status": "active",
        "subscriptionId": "<string>"
      }
    ],
    "billingGroup": {},
    "periods": [
      {
        "id": "<string>",
        "contractPeriodCount": 123,
        "contractPeriod": {},
        "cancellationPeriod": {},
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "status": "active",
    "activatedAt": "2021-01-01T00:00:00+00:00",
    "poNumber": "PO-00000001",
    "contractDetails": {
      "contractStart": "2023-11-07T05:31:56Z",
      "contractEnd": "2023-11-07T05:31:56Z"
    },
    "trialEndsOn": "2021-01-01T00:00:00+00:00",
    "customFields": {
      "field1": "value1",
      "field2": "value2"
    },
    "createdAt": "2021-01-01T00:00:00+00:00",
    "updatedAt": "2021-01-01T00:00:00+00:00",
    "defaultPaymentMethod": true,
    "defaultInvoiceAddress": true,
    "nextBillingDate": "2023-11-07T05:31:56Z",
    "lastBillingAt": "2023-11-07T05:31:56Z",
    "cancellationDate": "2023-11-07T05:31:56Z",
    "cancelledAt": "2023-11-07T05:31:56Z",
    "cancellationReason": {
      "createdAt": "2021-01-01T00:00:00+00:00",
      "updatedAt": "2021-01-01T00:00:00+00:00"
    },
    "isCancellationPending": true,
    "nextPossibleCancellationDate": [
      "<string>"
    ],
    "partner": {
      "id": "ad8f7e7d-3b3b-4b3b-8b3b-3b3b3b3b3b3b",
      "name": "John Doe",
      "number": "123456",
      "email": "[email protected]"
    }
  },
  "customer": {
    "id": "00000000-0000-0000-0000-000000000000",
    "customerNumber": "CUSTOMER-000",
    "timeZone": "Europe/Berlin",
    "firstName": "John",
    "lastName": "Doe",
    "currencyCode": "EUR",
    "companyName": "Acme Inc.",
    "datevId": "123456789",
    "status": "STATUS_ACTIVE"
  },
  "number": "<string>",
  "name": "<string>",
  "status": "open",
  "description": "<string>",
  "sections": [
    "<string>"
  ],
  "locale": "<string>",
  "recipients": [
    {
      "id": "<string>",
      "email": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "role": "read",
      "createdAt": "2023-11-07T05:31:56Z",
      "signingStatus": "not_started",
      "signingLog": [
        "<string>"
      ],
      "signedDocument": {
        "id": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ",
        "mimeType": "image/jpeg",
        "fileExtension": "jpg",
        "fileName": "invoice.jpg"
      },
      "link": "https://example.com/offers/1/recipient-1"
    }
  ],
  "auditLogDocument": {
    "id": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ",
    "mimeType": "image/jpeg",
    "fileExtension": "jpg",
    "fileName": "invoice.jpg"
  },
  "signedDocument": {
    "id": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ",
    "mimeType": "image/jpeg",
    "fileExtension": "jpg",
    "fileName": "invoice.jpg"
  },
  "signedAt": "2023-11-07T05:31:56Z",
  "autoActivateSubscription": true,
  "crmDealId": "<string>",
  "createdAt": "2021-01-01T00:00:00+00:00",
  "updatedAt": "2021-01-01T00:00:00+00:00",
  "contactPerson": {
    "id": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "<string>",
    "avatar": "<string>",
    "phone": "<string>",
    "linkedin": "<string>",
    "position": "<string>",
    "website": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Value for the Authorization header parameter.

Path Parameters

​
id
string
required

Offer identifier

Body

The new Offer resource

​
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
any

The role of the recipient

Possible values:

  • read: The recipient can read the offer
  • sign: The recipient can read and sign the offer
​
sendEmail
boolean

Whether to send an invitation email to the recipient. Otherwise, you have to inform the recipient manually.

Response

Offer resource created

​
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<date-time> | null
​
autoActivateSubscription
boolean
default:true
Example:

true

​
crmDealId
string | null
​
createdAt
string<date-time>

The date and time when the resource was created.

Example:

"2021-01-01T00:00:00+00:00"

​
updatedAt
string<date-time>

The date and time when the resource was last updated.

Example:

"2021-01-01T00:00:00+00:00"

​
contactPerson
object

The contact person of the offer