API Reference

Krystal Identity API

Resources & Endpoints

Update a mailing list subscription

Updates a mailing list subscription for the authenticated user to specify the current subscription status and any merge fields.

POST
https://identity.krystal.io/api/v1/mailing_list_subscriptions/{mailing_list}

If successful, this endpoint will return a 200 OK status.

Scopes

One of the following scopes are required to use this endpoint.

Arguments

The following arguments are supported for this endpoint.

Name Type Default Value

mailing_list Required

Mailing List Lookup None

properties Required

MailingListProperties None

Potential Errors

The following errors may occur during this request.

Details HTTP status

mailing_list_not_found

No mailing list was found matching any of the criteria provided in the arguments

 404 Not Found

Returned Object

When the request is successful, you can expect an object matching the specification below to be returned.

{
    mailing_list_subscription: MailingListSubscription {
        mailing_list: MailingList {
            name: String
            description: String
            permalink: String
        }
        active: Boolean
        merge_fields: [ KeyValue {
            key: String
            value: String?
        } ]
    }
}