Create a profile

A recipient should be uniquely identifiable using a string ID that will not change. For this reason, you should not use data such as an email address or phone number when assigning a recipient ID. This type of data may change over time.

More Examples

The following types of requests will not change the body of an existing Profile:

JSON

// Empty Profile Object
{
  "profile": {}
}

The above will result with:

200

{
  "status": "SUCCESS"
}

POSThttps://api.courier.com/profiles/:recipient_id

Merge the supplied values with an existing profile or create a new profile if one doesn't already exist.

PATH PARAMS

recipient_idstringrequired

A unique identifier representing the recipient associated with the requested profile.

BODY PARAM

profileobject

An object that includes any key-value pairs required by your chosen Integrations.

addressobject

formattedstring

street_addressstring

localitystring

regionstring

postal_codestring

countrystring

birthdatestring

emailstring

email_verifiedboolean

falsetrue

family_namestring

genderstring

given_namestring

localestring

middle_namestring

namestring

nicknamestring

phone_numberstring

phone_number_verifiedboolean

falsetrue

picturestring

preferred_namestring

profilestring

substring

updated_atstring

websitestring

zoneinfostring

customjson

A free form object. Due to a limitation of the API Explorer, you can only enter string key/values below, but this API accepts more complex object structures.

airshipobject

Learn more

audienceobject

named_userstring

device_typesarray

apnstring

Learn more

target_arnstring

Learn more

discordoneOf

Learn more

channel_idstring

expooneOf

Learn more

tokenstring

facebookPSIDstring

Learn more

firebaseTokenstring

Learn more

intercomobject

Learn more

fromstring

toobject

idstring

ms_teamsoneOf

Learn more

user_idstring

tenant_idstring

service_urlstring

oneSignalPlayerIDstring

Learn more

slackoneOf

Learn more

access_tokenstring

channelstring

webhookobject

Learn more

urlstring

methodstring

POSTGET

headersjson

authenticationobject

modestring

nonebasicbearer

usernamestring

passwordstring

tokenstring

profilestring

limitedexpanded

Responses

AUTH TOKEN

cURL

curl --request POST \
     --url https://api.courier.com/profiles/0460766e-8463-4905-ae98-b72c7aef41d6 \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --data '
{
  "profile": {
    "email": "user@example.com",
    "phone_number": "555-555-5555"
  }
}
'

Node.js

// Dependencies to install:
// $ npm install node-fetch --save

const fetch = require('node-fetch');

const options = {
  method: 'POST',
  headers: {
    Accept: 'application/json',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "profile": {
      "email": "user@example.com",
      "phone_number": "555-555-5555"
    }
  })
};

fetch('https://api.courier.com/profiles/0460766e-8463-4905-ae98-b72c7aef41d6', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

Ruby

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.courier.com/profiles/0460766e-8463-4905-ae98-b72c7aef41d6")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Accept"] = 'application/json'
request["Content-Type"] = 'application/json'
request.body = "{\"profile\":{\"email\":\"user@example.com\",\"phone_number\":\"555-555-5555\"}}"

response = http.request(request)
puts response.read_body

Python

# Dependencies to install:
# $ python -m pip install requests

import requests

url = "https://api.courier.com/profiles/0460766e-8463-4905-ae98-b72c7aef41d6"

payload = {
  "profile": {
    "email": "user@example.com",
    "phone_number": "555-555-5555"
  }
}
headers = {
  "Accept": "application/json",
  "Content-Type": "application/json"
}

response = requests.request("POST", url, json=payload, headers=headers)

print(response.text)

Go

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://api.courier.com/profiles/0460766e-8463-4905-ae98-b72c7aef41d6"

  payload := strings.NewReader("{\"profile\":{\"email\":\"user@example.com\",\"phone_number\":\"555-555-5555\"}}")

  req, _ := http.NewRequest("POST", url, payload)

  req.Header.Add("Accept", "application/json")
  req.Header.Add("Content-Type", "application/json")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

PHP

<?php
// Dependencies to install:
// $ composer require guzzlehttp/guzzle

require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.courier.com/profiles/0460766e-8463-4905-ae98-b72c7aef41d6', [
  'body' => '{"profile":{"email":"user@example.com","phone_number":"555-555-5555"}}',
  'headers' => [
    'Accept' => 'application/json',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();

Response Example

200 OK400 Bad Request

{
  "status": "SUCCESS"
}

Example

Method: POST

URL: https://api.courier.com/profiles/abcdefgh12345678

Body: ​

{
  "profile": {
    "name": "John Doe",
    "email": "user@example.com",
    "phone_number": "555-555-5555"
  }
}