Sender Profiles

GET

/workspaces/{workspaceId}/sender-profiles

Retrieve a list of sender profiles associated with the account

Parameter query

limit

integer

Limits the number of results to return.

pageToken

string

The cursor that keeps track of the current position in the results.

reverse

boolean

Reverses the order in which the results are returned.

Payload respons

results

array of object

wajib

Tampilkan atribut turunan

results.id

string

wajib

results.name

string

wajib

results.email

object

Tampilkan atribut turunan

results.email.username

string

wajib

results.email.domain

string

wajib

results.allowedEntities

array of object

Tampilkan atribut turunan

results.allowedEntities.entityType

string

wajib

Possible values: team, agent

results.allowedEntities.operation

string

Possible values: view, edit

results.allowedEntities.entityId

string

wajib

results.channelId

string

wajib

results.signature

string

results.createdAt

string

wajib

results.updatedAt

string

wajib

Contoh kode

curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/sender-profiles' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'

POST

/workspaces/{workspaceId}/sender-profiles

Create a new sender profile, defining its name, and other attributes.

Payload permintaan

name

string

wajib

username

string

allowedEntities

array of object

Tampilkan parameter turunan

allowedEntities.entityType

string

wajib

Possible values: team, agent

allowedEntities.operation

string

Possible values: view, edit

allowedEntities.entityId

string

wajib

channelId

string

wajib

signature

string

Contoh kode

curl -X POST 'https://api.bird.com/workspaces/{workspaceId}/sender-profiles' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'

GET

/workspaces/{workspaceId}/sender-profiles/{senderProfileId}

Retrieve information about a specific sender profile, including its name, and other attributes.

Payload respons

string

wajib

name

string

wajib

object

Tampilkan atribut turunan

email.username

string

wajib

email.domain

string

wajib

allowedEntities

array of object

Tampilkan atribut turunan

allowedEntities.entityType

string

wajib

Possible values: team, agent

allowedEntities.operation

string

Possible values: view, edit

allowedEntities.entityId

string

wajib

channelId

string

wajib

signature

string

createdAt

string

wajib

updatedAt

string

wajib

Contoh kode

curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/sender-profiles/{senderProfileId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'

PATCH

/workspaces/{workspaceId}/sender-profiles/{senderProfileId}

Modify the details of a specific sender profile, such as its name or other attributes.

Payload permintaan

name

string

username

string

signature

string

allowedEntities

array of object

Tampilkan parameter turunan

allowedEntities.entityType

string

wajib

Possible values: team, agent

allowedEntities.operation

string

Possible values: view, edit

allowedEntities.entityId

string

wajib

channelId

string

Payload respons

string

wajib

name

string

wajib

object

Tampilkan atribut turunan

email.username

string

wajib

email.domain

string

wajib

allowedEntities

array of object

Tampilkan atribut turunan

allowedEntities.entityType

string

wajib

Possible values: team, agent

allowedEntities.operation

string

Possible values: view, edit

allowedEntities.entityId

string

wajib

channelId

string

wajib

signature

string

createdAt

string

wajib

updatedAt

string

wajib

Contoh kode

curl -X PATCH 'https://api.bird.com/workspaces/{workspaceId}/sender-profiles/{senderProfileId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'

DELETE

/workspaces/{workspaceId}/sender-profiles/{senderProfileId}

Remove a specific sender profile.

Contoh kode

curl -X DELETE 'https://api.bird.com/workspaces/{workspaceId}/sender-profiles/{senderProfileId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'

GET

/workspaces/{workspaceId}/sender-profiles/signature-variables

Retrieve a list of variables to use for signature configuration in sender profile.

Payload respons

results

array of object

wajib

Tampilkan atribut turunan

results.id

string

results.name

string

results.defaultDescription

string

results.variable

string

results.category

string

results.replacementAttribute

string

results.langDescription

object

Contoh kode

curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/sender-profiles/signature-variables' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'

GET

/workspaces/{workspaceId}/users/{userId}/sender-profiles

Retrieve a list of sender profiles associated with a user.

Parameter query

channelId

string

Filter by channelId

Payload respons

results

array of object

wajib

Tampilkan atribut turunan

results.id

string

wajib

results.name

string

wajib

results.email

object

Tampilkan atribut turunan

results.email.username

string

wajib

results.email.domain

string

wajib

results.allowedEntities

array of object

Tampilkan atribut turunan

results.allowedEntities.entityType

string

wajib

Possible values: team, agent

results.allowedEntities.operation

string

Possible values: view, edit

results.allowedEntities.entityId

string

wajib

results.channelId

string

wajib

results.signature

string

results.createdAt

string

wajib

results.updatedAt

string

wajib

Contoh kode

curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/users/{userId}/sender-profiles' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'