logo

Update Objects

APIs related to updating Limio Objects

Update Object

This API allows you to update objects in Limio. You can update a subscription, customer, order, identity, address, schedule, payment method, subscription offer, promo code, or user entitlement. It is designed to be flexible and allow you to update any field in the object.

SecuritybearerAuth
Request
path Parameters
service
required
string
Default: "limio"

The service the object belongs to

Enum: "limio" "zuora" "salesforce"
path_type
required
string
Enum: "orders" "customers" "subscriptions" "identities" "address" "schedules" "payment_methods" "subscription_offers" "user_entitlements" "gift_code" "promo_codes_v2" "events" "process"
id
required
string
Example: sub-abcxyz123456
Request Body schema: application/json
required
name
string

The object name such as the subscription name, or gift code name. Not included values will not be updated and nested values will require the structure to update. Updates will only occur for the id provided. WARNING! Changing this field might break integrations

required
object or PromoCodeWholeBasket (object) or PromoCodeSelectedItems (object)
One of:
quantity
number
Responses
200

OK

400

Bad request (missing required fields)

401

Unauthorized

404

Not found

put/objects/{service}/{path_type}/{id}
Request samples
application/json
{
  • "name": "abc123",
  • "data": {
    }
}
Response samples
application/json
{
  • "id": "sub-123123123",
  • "sort_key": "object/subscription",
  • "data": {
    }
}

Delete Object

This API allows you to delete objects in Limio. Currently, only promo codes v2 are deleted via this API.

SecuritybearerAuth
Request
path Parameters
service
required
string
Default: "limio"

The service the object belongs to

Enum: "limio" "zuora" "salesforce"
path_type
required
string
Enum: "orders" "customers" "subscriptions" "identities" "address" "schedules" "payment_methods" "subscription_offers" "user_entitlements" "gift_code" "promo_codes_v2" "events" "process"
id
required
string
Example: sub-abcxyz123456
Responses
200

OK

401

Unauthorized

404

Not found

502

Bad Gateway

delete/objects/{service}/{path_type}/{id}
Request samples 
Response samples 
application/json
{
  • "httpStatusCode": 200,
  • "requestId": "1234ABC",
  • "attempts": 1,
  • "totalRetryDelay": 0
}
Add Object Relationship
This API allows you to add a related identity object to a specific object of provided path type from a provided service using the object's ID. You can add related objects of a subscription, customer, order, identity, address, schedule, payment method, subscription offer, or user entitlement.


SecuritybearerAuth 
Request 
path Parameters
service
required
string
 Default:  "limio"
The service the object belongs to


 Enum: "limio" "zuora" "salesforce"  
id
required
string
 
 Example:  sub-abcxyz123456
path_type
required
string
 Enum: "orders" "customers" "subscriptions" "identities" "address" "schedules" "payment_methods" "subscription_offers" "user_entitlements" "gift_code" "promo_codes_v2" "events" "process"  
record_type
required
string
 Default:  "identity"
Only identity is allowed


 
Request Body schema: application/json
required
Send order request


id
string
The identity to which you want to link the object to


 
service
string
The service of the identity


 Enum: "limio" "zuora" "salesforce"  
Responses 
200
OK


401
Unauthorized


502
Bad Gateway


post/objects/{service}/{path_type}/{id}/related/{record_type}
Request samples 
application/json
{
  • "id": "identity-bcc1997b17b7824caf86b06451904fb8",
  • "service": "limio"
}
Response samples 
application/json
null
➔ Next to Get Catalog Items