Skip to content
Post
/
Addresses
/
Create Return Address

Addresses

Everything about Post Addresses

We're no longer offering Post to new customers. If you're looking to reach people quickly, our SMS platform might be worth looking into.

Download OpenAPI description
addresses.json
addresses.yaml
Languages
Servers

https://rest.clicksend.com/

View Your Return Addresses

Request

Get list of post return addresses

Parameters

ParameterInTypeRequiredDescription
pagequeryinteger(int32)falsePage number
limitqueryinteger(int32)falseNumber of records per page

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint requires authentication,more info...
Security
basicAuth
Headers
Content-Typestring
Example: application/json
curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \

'https://rest.clicksend.com/v3/post/return-addresses'

Responses

Successful response

Bodyapplication/json
http_codeinteger

The HTTP status code of the response.

Example: 200
response_codestring

The response code indicating the status of the operation.

Example: "SUCCESS"
response_msgstring

A message describing the outcome of the operation.

Example: "Here are your records."
dataobject
Response
application/json
{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "Here are your records.",
  "data": {
    "total": 2,
    "per_page": 15,
    "current_page": 1,
    "last_page": 1,
    "next_page_url": null,
    "prev_page_url": null,
    "from": 1,
    "to": 2,
    "data": [ … ]
  }
}

Create Return Address

Request

Create post return address

Properties

NameTypeRequiredRestrictionsDescription
address_namestringtruenoneYour address name.
address_line_1stringtruenoneYour address line 1
address_citystringtruenoneYour city
address_postal_codestringtruenoneYour postal code
address_countrystringtruenoneYour country
address_line_2stringfalsenoneYour address line 2
address_statestringfalsenoneYour state

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint requires authentication,more info...
Security
basicAuth
Headers
Content-Typestring
Example: application/json
Bodyapplication/json
address_namestring
Example: "test"
address_line_1string
Example: "1 test street"
address_line_2string or null
address_citystring
Example: "Test"
address_postal_codestring
Example: "6000"
address_countrystring
Example: "AU"
curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \
     --request POST \

     --header "Content-Type: application/json" \
     --data-binary "{
    \"address_name\":\"John Smith\",
    \"address_line_1\":\"Maritime Avenue\",
    \"address_line_2\":\"\",
    \"address_city\":\"Flynn\",
    \"address_state\":\"WA\",
    \"address_postal_code\":6302,
    \"address_country\":\"AU\"
}" \
'https://rest.clicksend.com/v3/post/return-addresses'

Responses

Successful response

Bodyapplication/json
http_codeinteger

The HTTP status code of the response.

Example: 200
response_codestring

The response code indicating the status of the operation.

Example: "SUCCESS"
response_msgstring

A message describing the outcome of the operation.

Example: "New return address has been added."
dataobject(post_return_address)
Response
application/json
{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "New return address has been added.",
  "data": {
    "return_address_id": 4,
    "user_id": 1,
    "address_name": "My Address",
    "address_line_1": "Maritime Avenue",
    "address_line_2": "",
    "address_city": "Flynn",
    "address_state": "WA",
    "address_postal_code": "6302",
    "address_country": "AU"
  }
}

View Specific Return Address

Request

Get specific post return address

Parameters

ParameterInTypeRequiredDescription
return_address_idpathinteger(int32)trueReturn address ID

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint requires authentication,more info...
Security
basicAuth
Path
return_address_idstringrequired
Headers
Content-Typestring
Example: application/json
curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \

'https://rest.clicksend.com/v3/post/return-addresses/{return_address_id}'

Responses

Successful response

Bodyapplication/json
http_codeinteger

The HTTP status code of the response.

Example: 200
response_codestring

The response code indicating the status of the operation.

Example: "SUCCESS"
response_msgstring

A message describing the outcome of the operation.

Example: "Here is your data."
dataobject(post_return_address)
Response
application/json
{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "Here is your data.",
  "data": {
    "return_address_id": 4,
    "user_id": 1,
    "address_name": "My Address",
    "address_line_1": "Maritime Avenue",
    "address_line_2": "",
    "address_city": "Flynn",
    "address_state": "WA",
    "address_postal_code": "6302",
    "address_country": "AU"
  }
}

Update Return Address

Request

Update post return address

Parameters

ParameterInTypeRequiredDescription
return_address_idpathinteger(int32)trueReturn address ID

Properties

NameTypeRequiredRestrictionsDescription
address_namestringtruenoneYour address name.
address_line_1stringtruenoneYour address line 1
address_citystringtruenoneYour city
address_postal_codestringtruenoneYour postal code
address_countrystringtruenoneYour country
address_line_2stringfalsenoneYour address line 2
address_statestringfalsenoneYour state

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint requires authentication,more info...
Security
basicAuth
Path
return_address_idstringrequired
Headers
Content-Typestring
Example: application/json
Bodyapplication/json
address_countrystring
Example: "AU"
address_statestring or null
curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \
     --request PUT \

     --header "Content-Type: application/json" \
     --data-binary "{
    \"address_name\":\"John Smith\",
    \"address_line_1\":\"Maritime Avenue\",
    \"address_line_2\":\"\",
    \"address_city\":\"Flynn\",
    \"address_state\":\"WA\",
    \"address_postal_code\":6302,
    \"address_country\":\"AU\"
}" \
'https://rest.clicksend.com/v3/post/return-addresses/{return_address_id}'

Responses

Successful response

Bodyapplication/json
http_codeinteger

The HTTP status code of the response.

Example: 200
response_codestring

The response code indicating the status of the operation.

Example: "SUCCESS"
response_msgstring

A message describing the outcome of the operation.

Example: "Your return address has been updated."
dataobject(post_return_address)
Response
application/json
{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "Your return address has been updated.",
  "data": {
    "return_address_id": 4,
    "user_id": 1,
    "address_name": "My Address",
    "address_line_1": "Maritime Avenue",
    "address_line_2": "",
    "address_city": "Flynn",
    "address_state": "WA",
    "address_postal_code": "6302",
    "address_country": "AU"
  }
}

Delete Return Address

Request

Delete specific post return address

Parameters

ParameterInTypeRequiredDescription
return_address_idpathinteger(int32)trueReturn address ID

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint requires authentication,more info...
Security
basicAuth
Path
return_address_idstringrequired
Headers
Content-Typestring
Example: application/json
curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \
     --request DELETE \

'https://rest.clicksend.com/v3/post/return-addresses/{return_address_id}'

Responses

Successful response

Bodyapplication/json
http_codeinteger

The HTTP status code of the response.

Example: 200
response_codestring

The response code indicating the status of the operation.

Example: "SUCCESS"
response_msgstring

A message describing the outcome of the operation.

Example: "Your return address has been deleted."
dataArray of items
Example: []
Response
application/json
{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "Your return address has been deleted.",
  "data": []
}