Update a membership

View as Markdown

Authentication

AuthorizationBasic
Use your API key as the username and leave the password empty.
OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired

Request

This endpoint expects an object.
auto_record_callsenumOptional

Whether this member’s calls are automatically recorded. Starts as unset and can be set to enabled or disabled.

default_caller_idstring or nullOptional
ID of the phone number to use as this member's default outbound caller ID.
hangup_recording_urlstring or nullOptional
URL of the audio file used as this member's voicemail drop recording.
may_workflows_impersonatebooleanOptional
Whether Workflows may send emails on this member's behalf.
role_idstringOptional

One of admin, superuser, user, or restricteduser for the corresponding predefined role, or the ID of a custom Role.

track_email_opensbooleanOptional
Whether email opens are tracked for emails this member sends.

Response

Successful response

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error