Add a membership to an invoice

PUT https://api.zenoti.com/v1/invoices/{invoice_id}/memberships

Supply the url parameter invoice_id, request body and this api will update the requested invoice by booking the memberships aand returns the invoice id as the response.

Before you begin

Permission: Manage API Keys (on the Administrator security object) — Required to access Zenoti APIs.

Endpoint

PUT /v1/invoices/{invoice_id}/memberships

Base URL: https://api.zenoti.com

Request

Headers

Header Required Description
Authorization Yes bearer {{access_token}}

Path parameters

Parameter Type Required Description
invoice_id string Yes Unique identifier of the invoice.

Response

Success (200 OK)

{
  "invoice_id": "9f5bd424-4d16-48d1-821a-208463563152",
  "success": true
}

Response fields

Field Type Description
invoice_id string
success boolean

Example

curl --request PUT \
  --url 'https://api.zenoti.com/v1/invoices/{invoice_id}/memberships' \
  --header 'Authorization: bearer {{access_token}}'
const response = await fetch('https://api.zenoti.com/v1/invoices/{invoice_id}/memberships', {
  method: 'PUT',
  headers: {
    'Authorization': 'bearer {{access_token}}'
  },
});
const data = await response.json();
import requests

response = requests.put(
    'https://api.zenoti.com/v1/invoices/{invoice_id}/memberships',
    headers={
        'Authorization': 'bearer {{access_token}}',
    },
)
data = response.json()
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "bearer {{access_token}}");
var response = await client.PutAsync(
    "https://api.zenoti.com/v1/invoices/{invoice_id}/memberships");
var data = await response.Content.ReadAsStringAsync();
require 'net/http'
require 'json'

uri = URI('https://api.zenoti.com/v1/invoices/{invoice_id}/memberships')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Put.new(uri)
request['Authorization'] = 'bearer {{access_token}}'
response = http.request(request)
data = JSON.parse(response.body)

Error codes

Status Description
400 400
401 Unauthorized -- invalid or expired access token
429 Too many requests -- rate limit exceeded