logo

Subscriptions

Subscriptions are the contact options for a member. This can include email, SMS, and other contact methods.

Update Subscriptions

Updates the subscriptions for a member. This can be used instead of sending a PUT request to update the entire member. This is useful when you only want to update the subscriptions for a member. This will replace all the subscriptions for the member with the new subscriptions.

SecurityOAuth2
Request
path Parameters
member_id
required
string (Member_id)

The unique identifier for a member. This is the member that the subscriptions will be updated for.

Example: member1
Request Body schema: application/json
required

Payload to subscribe a member to a given contact method.

Array
category_id
required
string (SubscriptionCategoryID)

The unique identifier for a subscription category.

channel
required
string (Channel)

The channel option for a member. The channels that are available are setup by the Movio team.

Enum: "EMAIL" "SMS"
state
required
string
Default: "UNSUBSCRIBED"

Whether the member is subscribed to the contact option.

Enum: "SUBSCRIBED" "UNSUBSCRIBED"
Responses
204

The subscriptions were updated successfully.

400

The response to a bulk request that failed.

401

The request has not been applied because it lacks valid authentication credentials for the target resource.

422

The request was well-formed but was unable to be followed due to semantic errors.

patch/members/{member_id}/subscriptions
Request samples
application/json
[
  • {
    },
  • {
    }
]
Response samples
application/json
{
  • "message": "The request could not be understood by the server due to malformed syntax.",
  • "entities": [
    ]
}
➔ Next to Transactions