Profile

Controls what you can see and do within Outreach

createdAt
string or null <date-time>

The date and time the team was created.

isAdmin
boolean or null

Flag that indicates whether the profile provides admin access.

name
string or null <= 255 characters

The name of the profile (e.g. "Admin").

specialId
string or null <= 255 characters

The special id flag assigned to the profile (i.e. admin or default)

updatedAt
string or null <date-time>

The date and time the team was last updated.

{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "isAdmin": true,
  • "name": "string",
  • "specialId": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Profile Resource Metadata

METADATA NAME DESCRIPTION QUERY PARAM
canWrite A boolean value indicating whether the current API user has write access to this resource. provideAuthorizationMeta
canDelete A boolean value indicating whether the current API user has delete access to this resource. provideAuthorizationMeta

⌵ Profile Actions

Get a Collection of Profiles

SecuritybearerAuth
Responses
200

OK

422

JSON error message

get/profiles
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": [
    ]
}
Create a New Profile
SecuritybearerAuth 
Request 
Request Body schema: application/vnd.api+json
required
object
 
Responses 
201
Created


422
JSON error message


post/profiles
Request samples 
application/vnd.api+json
{
  • "data": {
    }
}
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}
Delete an Existing Profile by ID
SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Responses 
204
Deleted


422
JSON error message


delete/profiles/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "errors": [
    ]
}
Get a Profile by ID
SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Responses 
200
OK


404
Not Found


get/profiles/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}
Update a Profile
SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Request Body schema: application/vnd.api+json
required
object
 
Responses 
200
OK


422
JSON error message


patch/profiles/{id}
Request samples 
application/vnd.api+json
{
  • "data": {
    }
}
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}