Contents x
    Bulk update consent types
    • 19 Nov 2024
    • 1 Minute to read
    • Print
    • Dark
      Light
    Contents

    Bulk update consent types

    • Updated on 19 Nov 2024
    • 1 Minute to read
    • Print
    • Dark
      Light
    Article summary

    Put
    /messaging/client/{client_id}/consent/bulk

    This API is used to change the consent_types for multiple (up to 200) notification channels.

    Header parameters
    xx-relay-api-key
    stringRequired

    Contains the API key needed.

    Path parameters
    client_id
    stringRequired

    Client ID

    Minimum1
    Body parameters

    A customer onboard JSON document

    Expand All
    object
    batch
    Array of object
    object

    A array of unique channel addresses and their consent updates.

    channel_addr
    string

    Contains the channel address.

    Minimum10
    Max length11
    Example6105551212
    channel_type
    string

    Identifies the channel type of the channel_addr field.

    Valid values[ "sms" ]
    Examplesms
    consent_type
    string

    Identifies the consent of the Customer or Patient.

    Valid values[ "written", "express", "stop" ]
    Examplewritten
    Responses
    200

    Accepted

    400

    Invalid request

    401

    Unauthorized

    404

    Not Found - The requested resource was not found. Please verify the route parameter.

    409

    Conflict - Indicates the request could not be processed. A common reason is when attempting to create a new Journey object, but the ID already exists in the system.

    500

    An unexpected server error occurred. The response body should contain additional information related to the server error. Please retry your request.

    Was this article helpful?
    What's Next