Interface IOrganizationsApiPushProfiles

Namespace

Meraki.Api.Interfaces.General.Organizations

Assembly

Meraki.Api.dll

Interface for Push API Profiles

public interface IOrganizationsApiPushProfiles

Methods

CreateOrganizationApiPushProfileAsync(string, PushProfile, CancellationToken)

Create a Push API profile (subscribe to a topic) POST /organizations/{organizationId}/api/push/profiles

[Post("/organizations/{organizationId}/api/push/profiles")]
Task<PushProfile> CreateOrganizationApiPushProfileAsync(string organizationId, PushProfile pushProfile, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization ID

pushProfile PushProfile

The push profile to create

cancellationToken CancellationToken

The cancellation token

Returns

Task<PushProfile>

DeleteOrganizationApiPushProfileAsync(string, string, CancellationToken)

Delete a Push API profile DELETE /organizations/{organizationId}/api/push/profiles/{pushProfileIname}

[Delete("/organizations/{organizationId}/api/push/profiles/{pushProfileIname}")]
Task DeleteOrganizationApiPushProfileAsync(string organizationId, string pushProfileIname, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization ID

pushProfileIname string

The push profile immutable name

cancellationToken CancellationToken

The cancellation token

Returns

Task

UpdateOrganizationApiPushProfileAsync(string, string, PushProfileUpdateRequest, CancellationToken)

Update a Push API profile PUT /organizations/{organizationId}/api/push/profiles/{pushProfileIname}

[Put("/organizations/{organizationId}/api/push/profiles/{pushProfileIname}")]
Task<PushProfile> UpdateOrganizationApiPushProfileAsync(string organizationId, string pushProfileIname, PushProfileUpdateRequest updateRequest, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization ID

pushProfileIname string

The push profile immutable name

updateRequest PushProfileUpdateRequest

The update request

cancellationToken CancellationToken

The cancellation token

Returns

Task<PushProfile>