Management API Specification

v1.0.0

API

Download OpenAPI Document

JSON

Download OpenAPI Document

YAML

Servers

https://api2.sesamy.comCurrent environment

---

vendors

Operations

GET/management/vendorsPOST/management/vendors

---

GET /management/vendors

GET

/management/vendors

Authorizations

OpenID

TypeOpenID Connect (https://token.sesamy.com/.well-known/openid-configuration)

Responses

A list of vendors

Content-Type

application/json

[

{

"name": "string",

"id": "string",

"logo": "string"

}

]

GET

/management/vendors

Playground

Authorization

OpenID

Samples

cURL

JavaScript

PHP

Python

---

POST /management/vendors

POST

/management/vendors

Authorizations

OpenID

TypeOpenID Connect (https://token.sesamy.com/.well-known/openid-configuration)

Request Body

application/json

{

"name": "string",

"id": "string",

"website": "string",

"country": "string"

}

Responses

Status

POST

/management/vendors

Playground

Authorization

OpenID

Body

Samples

cURL

JavaScript

PHP

Python

---

bills

Operations

GET/management/billsGET/management/bills/{id}

---

GET /management/bills

GET

/management/bills

Authorizations

OpenID

TypeOpenID Connect (https://token.sesamy.com/.well-known/openid-configuration)

Parameters

Query Parameters

q

Typestring

limit

Typestring

from

Typestring

status

Typestring

Valid values

"DRAFT""PENDING""PAID""RETRYING""OVERDUE""CANCELED""EXPIRED""DELETED""VOIDED"

contractId

Typestring

Responses

Retrieve the users bills

Content-Type

application/json

[

{

"id": "1d78271264b9c76d5842911dd70b4353",

"items": [

{

"sku": "string",

"title": "string",

"purchaseOptionId": "string"

}

],

"price": 0,

"currency": "string",

"receiptUrl": "string",

"paymentProvider": "string",

"paymentMethod": "string",

"status": "string",

"updatedAt": "string",

"createdAt": "string"

}

]

GET

/management/bills

Playground

Authorization

OpenID

Variables

Key

Value

q

limit

from

status

contractId

Samples

cURL

JavaScript

PHP

Python

---

GET /management/bills/{id}

GET

/management/bills/{id}

Authorizations

OpenID

TypeOpenID Connect (https://token.sesamy.com/.well-known/openid-configuration)

Parameters

Path Parameters

id*

Typestring

Required

Example"1d78271264b9c76d5842911dd70b4353"

Responses

Retrieve the users bills

Content-Type

application/json

{

"id": "1d78271264b9c76d5842911dd70b4353",

"items": [

{

"sku": "string",

"title": "string",

"purchaseOptionId": "string"

}

],

"price": 0,

"currency": "string",

"receiptUrl": "string",

"paymentProvider": "string",

"paymentMethod": "string",

"status": "string",

"updatedAt": "string",

"createdAt": "string"

}

GET

/management/bills/{id}

Playground

Authorization

OpenID

Variables

Key

Value

id*

Samples

cURL

JavaScript

PHP

Python

---

contracts

Operations

GET/management/contractsGET/management/contracts/{id}

---

GET /management/contracts

GET

/management/contracts

Authorizations

OpenID

TypeOpenID Connect (https://token.sesamy.com/.well-known/openid-configuration)

Parameters

Query Parameters

q

Typestring

limit

Typestring

from

Typestring

userId

Typestring

Responses

Retrieve the users contracts

Content-Type

application/json

[

{

"id": "1d78271264b9c76d5842911dd70b4353",

"name": "string",

"userId": "string",

"createdAt": "string",

"updatedAt": "string",

"price": 0,

"nextBillAt": "string",

"nextPrice": 0,

"currency": "string",

"manageUrl": "string",

"contractDuration": "string",

"issuesRemaining": 0,

"items": [

{

"sku": "string",

"purchaseOptionId": "string",

"purchaseOptionName": "string",

"name": "string",

"cover": "string",

"purchaseType": "string"

}

],

"status": "string",

"isActive": true,

"recurringInterval": "string",

"recurringTime": 0,

"willCancelAt": "string",

"expiresAt": "string",

"paymentData": {

"method": "string",

"description": "string",

"brand": "string"

},

"appliedDiscounts": [

{

"code": "string",

"name": "string",

"description": "string",

"id": "string"

}

]

}

]

GET

/management/contracts

Playground

Authorization

OpenID

Variables

Key

Value

q

limit

from

userId

Samples

cURL

JavaScript

PHP

Python

---

GET /management/contracts/{id}

GET

/management/contracts/{id}

Authorizations

OpenID

TypeOpenID Connect (https://token.sesamy.com/.well-known/openid-configuration)

Parameters

Path Parameters

id*

Typestring

Required

Example"1d78271264b9c76d5842911dd70b4353"

Responses

Retrieve the users contracts

Content-Type

application/json

{

"id": "1d78271264b9c76d5842911dd70b4353",

"name": "string",

"userId": "string",

"createdAt": "string",

"updatedAt": "string",

"price": 0,

"nextBillAt": "string",

"nextPrice": 0,

"currency": "string",

"manageUrl": "string",

"contractDuration": "string",

"issuesRemaining": 0,

"items": [

{

"sku": "string",

"purchaseOptionId": "string",

"purchaseOptionName": "string",

"name": "string",

"cover": "string",

"purchaseType": "string"

}

],

"status": "string",

"isActive": true,

"recurringInterval": "string",

"recurringTime": 0,

"willCancelAt": "string",

"expiresAt": "string",

"paymentData": {

"method": "string",

"description": "string",

"brand": "string"

},

"appliedDiscounts": [

{

"code": "string",

"name": "string",

"description": "string",

"id": "string"

}

]

}

GET

/management/contracts/{id}

Playground

Authorization

OpenID

Variables

Key

Value

id*

Samples

cURL

JavaScript

PHP

Python

---

transactions

Operations

GET/management/transactions

---

GET /management/transactions

GET

/management/transactions

Authorizations

OpenID

TypeOpenID Connect (https://token.sesamy.com/.well-known/openid-configuration)

Parameters

Query Parameters

q

Typestring

transactionId

Typestring

billId

Typestring

contractId

Typestring

userId

Typestring

dateFrom

Typestring

dateTo

Typestring

limit

Typestring

from

Typestring

Responses

A list of transactions

Content-Type

application/json

[

{

"id": "1d78271264b9c76d5842911dd70b4353",

"amount": 0,

"currency": "string",

"contractId": "string",

"isRefund": true,

"userId": "string",

"billId": "string",

"updatedAt": "string",

"createdAt": "string"

}

]

GET

/management/transactions

Playground

Authorization

OpenID

Variables

Key

Value

q

transactionId

billId

contractId

userId

dateFrom

dateTo

limit

from

Samples

cURL

JavaScript

PHP

Python

---

products

Operations

GET/management/productsPOST/management/productsGET/management/products/{sku}PATCH/management/products/{sku}GET/management/products/{sku}/fulfillments

---

GET /management/products

GET

/management/products

Authorizations

OpenID

TypeOpenID Connect (https://token.sesamy.com/.well-known/openid-configuration)

Parameters

Query Parameters

q

Typestring

Responses

Retrieve a list of products

Content-Type

application/json

[

{

"cover": "string",

"language": "string",

"createdAt": "string",

"updatedAt": "string",

"sku": "string",

"title": "string",

"productType": "string",

"publisherContentId": "string"

}

]

GET

/management/products

Playground

Authorization

OpenID

Variables

Key

Value

q

Samples

cURL

JavaScript

PHP

Python

---

POST /management/products

POST

/management/products

Authorizations

OpenID

TypeOpenID Connect (https://token.sesamy.com/.well-known/openid-configuration)

Request Body

application/json

{

"type": "string",

"url": "string",

"spotifyId": "string"

}

Responses

A created product

Content-Type

application/json

{

"cover": "string",

"language": "string",

"createdAt": "string",

"updatedAt": "string",

"sku": "string",

"title": "string",

"productType": "string",

"publisherContentId": "string"

}

POST

/management/products

Playground

Authorization

OpenID

Body

Samples

cURL

JavaScript

PHP

Python

---

GET /management/products/{sku}

GET

/management/products/{sku}

Authorizations

OpenID

TypeOpenID Connect (https://token.sesamy.com/.well-known/openid-configuration)

Parameters

Path Parameters

sku*

Typestring

Required

Responses

Retrieve a a product by SKU

Content-Type

application/json

{

"cover": "string",

"language": "string",

"createdAt": "string",

"updatedAt": "string",

"sku": "string",

"title": "string",

"productType": "string",

"publisherContentId": "string"

}

GET

/management/products/{sku}

Playground

Authorization

OpenID

Variables

Key

Value

sku*

Samples

cURL

JavaScript

PHP

Python

---

PATCH /management/products/{sku}

PATCH

/management/products/{sku}

Authorizations

OpenID

TypeOpenID Connect (https://token.sesamy.com/.well-known/openid-configuration)

Parameters

Path Parameters

sku*

Typestring

Required

Request Body

application/json

{

"externalIds": {

"spotifyId": "string"

},

"language": "string"

}

Responses

A created product

PATCH

/management/products/{sku}

Playground

Authorization

OpenID

Variables

Key

Value

sku*

Body

Samples

cURL

JavaScript

PHP

Python

---

GET /management/products/{sku}/fulfillments

GET

/management/products/{sku}/fulfillments

Authorizations

OpenID

TypeOpenID Connect (https://token.sesamy.com/.well-known/openid-configuration)

Parameters

Path Parameters

sku*

Typestring

Required

Responses

Retrieve a a product by SKU

Content-Type

application/json

[

{

"status": "string",

"updatedAt": "string",

"createdAt": "string",

"deliversAt": "string",

"sku": "string",

"title": "string"

}

]

GET

/management/products/{sku}/fulfillments

Playground

Authorization

OpenID

Variables

Key

Value

sku*

Samples

cURL

JavaScript

PHP

Python

---

Users

Operations

GET/management/usersPOST/management/usersGET/management/users/{user_id}DELETE/management/users/{user_id}PATCH/management/users/{user_id}POST/management/users/{user_id}/change-login-identifierPUT/management/users/{user_id}/user_metadata/{key}DELETE/management/users/{user_id}/user_metadata/{key}POST/management/users/{user_id}/set-password

---

List users

GET

/management/users

Returns a list of users with optional filtering.

Authorizations

OpenID

TypeOpenID Connect (https://token.sesamy.com/.well-known/openid-configuration)

Parameters

Query Parameters

q

Typestring

Example"john"

limit

Typestring

Example"10"

from

Typestring

Example"0"

Responses

A list of users matching the query parameters

Content-Type

application/json

[

{

"userId": "string",

"firstName": "string",

"lastName": "string",

"email": "string",

"emailVerified": true,

"locale": "string",

"nickname": "string",

"picture": "string",

"name": "string",

"mobilePhone": "string",

"workPhone": "string",

"homePhone": "string",

"tags": [

"string"

],

"user_metadata": {

"additionalProperties": "string"

},

"billingAddress": {

"country": "string",

"zip": "string",

"city": "string",

"street": "string",

"co": "string",

"lastName": "string",

"firstName": "string"

},

"deliveryAddress": {

"country": "string",

"zip": "string",

"city": "string",

"street": "string",

"co": "string",

"lastName": "string",

"firstName": "string"

},

"createdAt": "string",

"updatedAt": "string",

"company": "string",

"sub": "string",

"given_name": "string",

"family_name": "string",

"phone_number": "string"

}

]

GET

/management/users

Playground

Authorization

OpenID

Variables

Key

Value

q

limit

from

Samples

cURL

JavaScript

PHP

Python

---

Create a user

POST

/management/users

Creates a new user with the specified email and optional name.

Authorizations

OpenID

TypeOpenID Connect (https://token.sesamy.com/.well-known/openid-configuration)

Request Body

application/json

{

"email": "new.user@example.com",

"firstName": "New",

"lastName": "User"

}

Responses

User created successfully

Content-Type

application/json

{

"success": true

}

POST

/management/users

Playground

Authorization

OpenID

Body

Samples

cURL

JavaScript

PHP

Python

---

Get a user by ID

GET

/management/users/{user_id}

Retrieves a specific user's profile by their ID.

Authorizations

OpenID

TypeOpenID Connect (https://token.sesamy.com/.well-known/openid-configuration)

Parameters

Path Parameters

user_id*

The unique identifier of the user

Typestring

Required

Example"user123"

Responses

The requested user profile

Content-Type

application/json

{

"userId": "string",

"firstName": "string",

"lastName": "string",

"email": "string",

"emailVerified": true,

"locale": "string",

"nickname": "string",

"picture": "string",

"name": "string",

"mobilePhone": "string",

"workPhone": "string",

"homePhone": "string",

"tags": [

"string"

],

"user_metadata": {

"additionalProperties": "string"

},

"billingAddress": {

"country": "string",

"zip": "string",

"city": "string",

"street": "string",

"co": "string",

"lastName": "string",

"firstName": "string"

},

"deliveryAddress": {

"country": "string",

"zip": "string",

"city": "string",

"street": "string",

"co": "string",

"lastName": "string",

"firstName": "string"

},

"createdAt": "string",

"updatedAt": "string",

"company": "string",

"sub": "string",

"given_name": "string",

"family_name": "string",

"phone_number": "string"

}

GET

/management/users/{user_id}

Playground

Authorization

OpenID

Variables

Key

Value

user_id*

Samples

cURL

JavaScript

PHP

Python

---

Delete a user

DELETE

/management/users/{user_id}

Deletes a user from the auth server. This action is irreversible.

Authorizations

OpenID

TypeOpenID Connect (https://token.sesamy.com/.well-known/openid-configuration)

Parameters

Path Parameters

user_id*

The unique identifier of the user

Typestring

Required

Example"user123"

Responses

User deleted successfully

Content-Type

application/json

{

"success": true

}

DELETE

/management/users/{user_id}

Playground

Authorization

OpenID

Variables

Key

Value

user_id*

Samples

cURL

JavaScript

PHP

Python

---

Update a user

PATCH

/management/users/{user_id}

Updates a specific user's profile with the provided data.

Authorizations

OpenID

TypeOpenID Connect (https://token.sesamy.com/.well-known/openid-configuration)

Parameters

Path Parameters

user_id*

The unique identifier of the user

Typestring

Required

Example"user123"

Request Body

application/json

{

"firstName": "John",

"lastName": "Doe",

"nickname": "Johnny",

"mobilePhone": "+1234567890",

"workPhone": "+1234567891",

"homePhone": "+1234567892",

"billingAddress": {

"country": "string",

"zip": "string",

"city": "string",

"street": "string",

"co": "string",

"lastName": "string",

"firstName": "string"

},

"deliveryAddress": {

"country": "string",

"zip": "string",

"city": "string",

"street": "string",

"co": "string",

"lastName": "string",

"firstName": "string"

},

"given_name": "string",

"family_name": "string",

"phone_number": "string"

}

Responses

The updated user profile

Content-Type

application/json

{

"userId": "string",

"firstName": "string",

"lastName": "string",

"email": "string",

"emailVerified": true,

"locale": "string",

"nickname": "string",

"picture": "string",

"name": "string",

"mobilePhone": "string",

"workPhone": "string",

"homePhone": "string",

"tags": [

"string"

],

"user_metadata": {

"additionalProperties": "string"

},

"billingAddress": {

"country": "string",

"zip": "string",

"city": "string",

"street": "string",

"co": "string",

"lastName": "string",

"firstName": "string"

},

"deliveryAddress": {

"country": "string",

"zip": "string",

"city": "string",

"street": "string",

"co": "string",

"lastName": "string",

"firstName": "string"

},

"createdAt": "string",

"updatedAt": "string",

"company": "string",

"sub": "string",

"given_name": "string",

"family_name": "string",

"phone_number": "string"

}

PATCH

/management/users/{user_id}

Playground

Authorization

OpenID

Variables

Key

Value

user_id*

Body

Samples

cURL

JavaScript

PHP

Python

---

Change user login identifier

POST

/management/users/{user_id}/change-login-identifier

Changes the email address that a user uses to log in.

Authorizations

OpenID

TypeOpenID Connect (https://token.sesamy.com/.well-known/openid-configuration)

Parameters

Path Parameters

user_id*

The unique identifier of the user

Typestring

Required

Example"user123"

Request Body

application/json

{

"email": "new.email@example.com"

}

Responses

Login identifier changed successfully

Content-Type

application/json

{

"success": true

}

POST

/management/users/{user_id}/change-login-identifier

Playground

Authorization

OpenID

Variables

Key

Value

user_id*

Body

Samples

cURL

JavaScript

PHP

Python

---

Set user metadata value

PUT

/management/users/{user_id}/user_metadata/{key}

Sets a metadata value for a specific user with the specified key.

Authorizations

OpenID

TypeOpenID Connect (https://token.sesamy.com/.well-known/openid-configuration)

Parameters

Path Parameters

user_id*

The unique identifier of the user

Typestring

Required

Example"user123"

key*

The key of the metadata entry

Typestring

Required

Example"preferences"

Request Body

text/plain

"string"

Responses

Metadata value set successfully

Content-Type

application/json

{

"success": true

}

PUT

/management/users/{user_id}/user_metadata/{key}

Playground

Authorization

OpenID

Variables

Key

Value

user_id*

key*

Body

Samples

cURL

JavaScript

PHP

Python

---

Delete user metadata value

DELETE

/management/users/{user_id}/user_metadata/{key}

Deletes a metadata value for a specific user with the specified key.

Authorizations

OpenID

TypeOpenID Connect (https://token.sesamy.com/.well-known/openid-configuration)

Parameters

Path Parameters

user_id*

The unique identifier of the user

Typestring

Required

Example"user123"

key*

The key of the metadata entry

Typestring

Required

Example"preferences"

Responses

Metadata value deleted successfully

Content-Type

application/json

{

"success": true

}

DELETE

/management/users/{user_id}/user_metadata/{key}

Playground

Authorization

OpenID

Variables

Key

Value

user_id*

key*

Samples

cURL

JavaScript

PHP

Python

---

Set user password

POST

/management/users/{user_id}/set-password

Sets or updates the password for a user. Creates a password authentication method if one does not exist.

Authorizations

OpenID

TypeOpenID Connect (https://token.sesamy.com/.well-known/openid-configuration)

Parameters

Path Parameters

user_id*

The unique identifier of the user

Typestring

Required

Example"user123"

Request Body

application/json

{

"password": "SecurePassword123!"

}

Responses

Password set successfully

Content-Type

application/json

{

"success": true

}

POST

/management/users/{user_id}/set-password

Playground

Authorization

OpenID

Variables

Key

Value

user_id*

Body

Samples

cURL

JavaScript

PHP

Python

---

Compatibility

Operations

GET/management/mc/customers/{customerId}

---

Get customer information

GET

/management/mc/customers/{customerId}

Returns customer information in XML format for Mediaconnect compatibility.

Authorizations

OpenID

TypeOpenID Connect (https://token.sesamy.com/.well-known/openid-configuration)

+

Basic

TypeHTTP (basic)

Parameters

Path Parameters

customerId*

The unique identifier of the customer

Typestring

Required

Example"958280"

Responses

Customer information in XML format

Content-Type

application/xml

GET

/management/mc/customers/{customerId}

Playground

Authorization

OpenID

Basic

Variables

Key

Value

customerId*

Samples

cURL

JavaScript

PHP

Python

---

entitlements

Operations

GET/management/entitlements

---

GET /management/entitlements

GET

/management/entitlements

Authorizations

OpenID

TypeOpenID Connect (https://token.sesamy.com/.well-known/openid-configuration)

Parameters

Query Parameters

q

Typestring

Example"premium article"

limit

Typestring

Example"20"

from

Typestring

Example"cursor123"

userId*

Typestring

Required

Example"user123"

type

Typestring

Valid values

"article""audiobook""ebook""bundle""podcast""pass""publication""physical_issue"

Example"article"

sku

Typestring

Example"premium-article-123"

Responses

List of entitlements

Content-Type

application/json

[

{

"id": "1d78271264b9c76d5842911dd70b4353",

"sku": "string",

"purchaseOption": "string",

"cover": "string",

"title": "string",

"url": "string",

"presentationUrl": "string",

"publisherContentId": "string",

"type": "string",

"origin": {

"type": "string",

"id": "string",

"listId": "string",

"name": "string"

},

"hasAccess": true,

"createdAt": "string",

"updatedAt": "string",

"token": "string",

"expiresAt": "string"

}

]

GET

/management/entitlements

Playground

Authorization

OpenID

Variables

Key

Value

q

limit

from

userId*

type

sku

Samples

cURL

JavaScript

PHP

Python

---

Powered by VitePress OpenAPI