API Reference

Create or update a profile

post
https://app.gobluebird.io/extapi//profile/updateOrCreate

Creates a new profile or updates an existing profile matched by email.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Company slug from the goBluebird URL.

Body Params

Profile details to create or update.

Profile details to create or update.

string
required

Profile name.

string

Profile phone number.

string
required

Profile email address. Used to match an existing profile.

string

Profile role.

boolean

Whether this profile can receive catchall leads.

boolean

Whether this profile can receive text messages.

boolean

Whether this profile can receive emails.

boolean

Whether this profile is currently available to receive leads.

string

Destination used when accepted leads should be forwarded.

tags
array of strings

Tags assigned to the profile.

tags
exclusive_tags
array of strings

Tags that exclusively route matching leads to this profile.

exclusive_tags
required_tags
array of strings

Tags required for this profile to be considered during routing.

required_tags
geolocation
array of strings

Locations associated with the profile.

geolocation
string

Profile locale.

string

External system identifier for this profile.

string

External system label for this profile.

string

Custom tracking field.

string

Custom tracking field.

Responses
200

Success.

400

The request was invalid.

401

Authentication is missing or invalid.

403

The API token is not authorized for this company or operation.

500

An unexpected server error occurred.

Updated 2 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here!

Updated 2 months ago

Did this page help you?